From 64e959ffe37c436503f9fed1ce2d6ee6ae50bd9a Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Fri, 13 Nov 2015 16:15:26 +0100 Subject: cleanup: general removal of TODO (and similar) comments They tend to never get updated anyway so they're frequently inaccurate and we never go back to revisit them anyway. We document issues to work on properly in KNOWN_BUGS and TODO instead. --- lib/asyn-ares.c | 1 - lib/curl_memory.h | 4 ++-- lib/easy.c | 2 +- lib/ftp.c | 2 +- lib/http.c | 7 +------ lib/http2.c | 5 +---- lib/imap.c | 20 ++++++++++---------- lib/openldap.c | 6 +----- lib/rtsp.c | 13 ------------- lib/smtp.c | 6 ++---- lib/splay.c | 2 +- lib/ssh.c | 14 +++----------- lib/telnet.c | 1 - lib/url.c | 2 -- lib/vtls/gtls.c | 6 ------ lib/vtls/openssl.c | 5 ----- lib/x509asn1.c | 5 ----- src/tool_cb_prg.c | 10 +++------- src/tool_operate.c | 12 ------------ 19 files changed, 26 insertions(+), 97 deletions(-) diff --git a/lib/asyn-ares.c b/lib/asyn-ares.c index 98ecdfd71..080010222 100644 --- a/lib/asyn-ares.c +++ b/lib/asyn-ares.c @@ -416,7 +416,6 @@ CURLcode Curl_resolver_wait_resolv(struct connectdata *conn, if(result) /* close the connection, since we can't return failure here without cleaning up this connection properly. - TODO: remove this action from here, it is not a name resolver decision. */ connclose(conn, "c-ares resolve failed"); diff --git a/lib/curl_memory.h b/lib/curl_memory.h index bc744ccd8..73bbe3fca 100644 --- a/lib/curl_memory.h +++ b/lib/curl_memory.h @@ -7,7 +7,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2013, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -39,7 +39,7 @@ * * File lib/strdup.c is an exception, given that it provides a strdup * clone implementation while using malloc. Extra care needed inside - * this one. TODO: revisit this paragraph and related code. + * this one. * * The need for curl_memory.h inclusion is due to libcurl's feature * of allowing library user to provide memory replacement functions, diff --git a/lib/easy.c b/lib/easy.c index 48961d6da..f90dd1694 100644 --- a/lib/easy.c +++ b/lib/easy.c @@ -646,7 +646,7 @@ static CURLcode wait_or_timeout(struct Curl_multi *multi, struct events *ev) return CURLE_RECV_ERROR; if(mcode) - return CURLE_URL_MALFORMAT; /* TODO: return a proper error! */ + return CURLE_URL_MALFORMAT; /* we don't really care about the "msgs_in_queue" value returned in the second argument */ diff --git a/lib/ftp.c b/lib/ftp.c index 21db56c8e..bf35ed7da 100644 --- a/lib/ftp.c +++ b/lib/ftp.c @@ -3659,7 +3659,7 @@ static CURLcode ftp_do_more(struct connectdata *conn, int *completep) if(!conn->bits.tcpconnect[SECONDARYSOCKET]) { if(conn->tunnel_state[SECONDARYSOCKET] == TUNNEL_CONNECT) { /* As we're in TUNNEL_CONNECT state now, we know the proxy name and port - aren't used so we blank their arguments. TODO: make this nicer */ + aren't used so we blank their arguments. */ result = Curl_proxyCONNECT(conn, SECONDARYSOCKET, NULL, 0, FALSE); return result; diff --git a/lib/http.c b/lib/http.c index b652c2e8b..12a70d6de 100644 --- a/lib/http.c +++ b/lib/http.c @@ -2044,10 +2044,7 @@ CURLcode Curl_http(struct connectdata *conn, bool *done) ptr = strstr(url, conn->host.dispname); if(ptr) { /* This is where the display name starts in the URL, now replace this - part with the encoded name. TODO: This method of replacing the host - name is rather crude as I believe there's a slight risk that the - user has entered a user name or password that contain the host name - string. */ + part with the encoded name. */ size_t currlen = strlen(conn->host.dispname); size_t newlen = strlen(conn->host.name); size_t urllen = strlen(url); @@ -3329,7 +3326,6 @@ CURLcode Curl_http_readwrite_headers(struct SessionHandle *data, conn->httpversion = 11; /* For us, RTSP acts like HTTP 1.1 */ } else { - /* TODO: do we care about the other cases here? */ nc = 0; } } @@ -3560,7 +3556,6 @@ CURLcode Curl_http_readwrite_headers(struct SessionHandle *data, } if(k->auto_decoding) - /* TODO: we only support the first mentioned compression for now */ break; if(checkprefix("identity", start)) { diff --git a/lib/http2.c b/lib/http2.c index e76200720..9594e6c5c 100644 --- a/lib/http2.c +++ b/lib/http2.c @@ -75,8 +75,6 @@ static int http2_perform_getsock(const struct connectdata *conn, int bitmap = GETSOCK_BLANK; (void)numsocks; - /* TODO We should check underlying socket state if it is SSL socket - because of renegotiation. */ sock[0] = conn->sock[FIRSTSOCKET]; if(nghttp2_session_want_read(c->h2)) @@ -576,8 +574,7 @@ static int on_data_chunk_recv(nghttp2_session *session, uint8_t flags, /* if we receive data for another handle, wake that up */ if(conn->data != data_s) - Curl_expire(data_s, 1); /* TODO: fix so that this can be set to 0 for - immediately? */ + Curl_expire(data_s, 1); DEBUGF(infof(data_s, "%zu data received for stream %u " "(%zu left in buffer %p, total %zu)\n", diff --git a/lib/imap.c b/lib/imap.c index a7409f704..bb0c5190f 100644 --- a/lib/imap.c +++ b/lib/imap.c @@ -842,7 +842,7 @@ static CURLcode imap_state_servergreet_resp(struct connectdata *conn, if(imapcode != 'O') { failf(data, "Got unexpected imap-server response"); - result = CURLE_FTP_WEIRD_SERVER_REPLY; /* TODO: fix this code */ + result = CURLE_FTP_WEIRD_SERVER_REPLY; } else result = imap_perform_capability(conn); @@ -1033,7 +1033,7 @@ static CURLcode imap_state_list_resp(struct connectdata *conn, int imapcode, line[len] = '\0'; } else if(imapcode != 'O') - result = CURLE_QUOTE_ERROR; /* TODO: Fix error code */ + result = CURLE_QUOTE_ERROR; else /* End of DO phase */ state(conn, IMAP_STOP); @@ -1105,7 +1105,7 @@ static CURLcode imap_state_fetch_resp(struct connectdata *conn, int imapcode, if(imapcode != '*') { Curl_pgrsSetDownloadSize(data, -1); state(conn, IMAP_STOP); - return CURLE_REMOTE_FILE_NOT_FOUND; /* TODO: Fix error code */ + return CURLE_REMOTE_FILE_NOT_FOUND; } /* Something like this is received "* 1 FETCH (BODY[TEXT] {2021}\r" so parse @@ -1174,7 +1174,7 @@ static CURLcode imap_state_fetch_resp(struct connectdata *conn, int imapcode, else { /* We don't know how to parse this line */ failf(pp->conn->data, "Failed to parse FETCH response."); - result = CURLE_FTP_WEIRD_SERVER_REPLY; /* TODO: fix this code */ + result = CURLE_FTP_WEIRD_SERVER_REPLY; } /* End of DO phase */ @@ -1193,7 +1193,7 @@ static CURLcode imap_state_fetch_final_resp(struct connectdata *conn, (void)instate; /* No use for this yet */ if(imapcode != 'O') - result = CURLE_FTP_WEIRD_SERVER_REPLY; /* TODO: Fix error code */ + result = CURLE_FTP_WEIRD_SERVER_REPLY; else /* End of DONE phase */ state(conn, IMAP_STOP); @@ -1262,7 +1262,7 @@ static CURLcode imap_state_search_resp(struct connectdata *conn, int imapcode, line[len] = '\0'; } else if(imapcode != 'O') - result = CURLE_QUOTE_ERROR; /* TODO: Fix error code */ + result = CURLE_QUOTE_ERROR; else /* End of DO phase */ state(conn, IMAP_STOP); @@ -1506,10 +1506,10 @@ static CURLcode imap_done(struct connectdata *conn, CURLcode status, /* Run the state-machine - TODO: when the multi interface is used, this _really_ should be using - the imap_multi_statemach function but we have no general support for - non-blocking DONE operations, not in the multi state machine and with - Curl_done() invokes on several places in the code! + This _really_ should be using the imap_multi_statemach function but we + have no general support for non-blocking DONE operations. Neither in + the multi state machine and there are Curl_done() invokes on several + places in the code! */ if(!result) result = imap_block_statemach(conn); diff --git a/lib/openldap.c b/lib/openldap.c index e479ebc75..862813b41 100644 --- a/lib/openldap.c +++ b/lib/openldap.c @@ -176,9 +176,7 @@ static CURLcode ldap_setup_connection(struct connectdata *conn) li->proto = proto; conn->proto.generic = li; connkeep(conn, "OpenLDAP default"); - /* TODO: - * - provide option to choose SASL Binds instead of Simple - */ + return CURLE_OK; } @@ -481,8 +479,6 @@ static ssize_t ldap_recv(struct connectdata *conn, int sockindex, char *buf, lr->nument++; rc = ldap_get_dn_ber(li->ld, ent, &ber, &bv); if(rc < 0) { - /* TODO: verify that this is really how this return code should be - handled */ *err = CURLE_RECV_ERROR; return -1; } diff --git a/lib/rtsp.c b/lib/rtsp.c index f8e6b23dc..d190eef9f 100644 --- a/lib/rtsp.c +++ b/lib/rtsp.c @@ -42,16 +42,6 @@ #include "curl_memory.h" #include "memdebug.h" -/* - * TODO (general) - * -incoming server requests - * -server CSeq counter - * -digest authentication - * -connect thru proxy - * -pipelining? - */ - - #define RTP_PKT_CHANNEL(p) ((int)((unsigned char)((p)[1]))) #define RTP_PKT_LENGTH(p) ((((int)((unsigned char)((p)[2]))) << 8) | \ @@ -222,7 +212,6 @@ static CURLcode rtsp_done(struct connectdata *conn, else if(data->set.rtspreq == RTSPREQ_RECEIVE && (conn->proto.rtspc.rtp_channel == -1)) { infof(data, "Got an RTP Receive with a CSeq of %ld\n", CSeq_recv); - /* TODO CPC: Server -> Client logic here */ } } @@ -328,8 +317,6 @@ static CURLcode rtsp_do(struct connectdata *conn, bool *done) return CURLE_BAD_FUNCTION_ARGUMENT; } - /* TODO: proxy? */ - /* Stream URI. Default to server '*' if not specified */ if(data->set.str[STRING_RTSP_STREAM_URI]) { p_stream_uri = data->set.str[STRING_RTSP_STREAM_URI]; diff --git a/lib/smtp.c b/lib/smtp.c index dada087a9..3eb534cd3 100644 --- a/lib/smtp.c +++ b/lib/smtp.c @@ -1256,10 +1256,8 @@ static CURLcode smtp_done(struct connectdata *conn, CURLcode status, /* Run the state-machine - TODO: when the multi interface is used, this _really_ should be using - the smtp_multi_statemach function but we have no general support for - non-blocking DONE operations, not in the multi state machine and with - Curl_done() invokes on several places in the code! + this should be using the smtp_multi_statemach function but we have no + support for non-blocking DONE operations! */ result = smtp_block_statemach(conn); } diff --git a/lib/splay.c b/lib/splay.c index b87b6cfe2..aec353b2d 100644 --- a/lib/splay.c +++ b/lib/splay.c @@ -211,7 +211,7 @@ struct Curl_tree *Curl_splaygetbest(struct timeval i, /* Deletes the very node we point out from the tree if it's there. Stores a * pointer to the new resulting tree in 'newroot'. * - * Returns zero on success and non-zero on errors! TODO: document error codes. + * Returns zero on success and non-zero on errors! * When returning error, it does not touch the 'newroot' pointer. * * NOTE: when the last node of the tree is removed, there's no tree left so diff --git a/lib/ssh.c b/lib/ssh.c index f9bbdf104..2b01e94f5 100644 --- a/lib/ssh.c +++ b/lib/ssh.c @@ -296,10 +296,6 @@ static CURLcode libssh2_session_error_to_CURLE(int err) return CURLE_AGAIN; } - /* TODO: map some more of the libssh2 errors to the more appropriate CURLcode - error code, and possibly add a few new SSH-related one. We must however - not return or even depend on libssh2 errors in the public libcurl API */ - return CURLE_SSH; } @@ -2824,10 +2820,8 @@ static CURLcode ssh_connect(struct connectdata *conn, bool *done) if(data->set.str[STRING_SSH_KNOWNHOSTS]) { int rc; ssh->kh = libssh2_knownhost_init(ssh->ssh_session); - if(!ssh->kh) { - /* eeek. TODO: free the ssh_session! */ + if(!ssh->kh) return CURLE_FAILED_INIT; - } /* read all known hosts from there */ rc = libssh2_knownhost_readfile(ssh->kh, @@ -2964,10 +2958,8 @@ static CURLcode ssh_done(struct connectdata *conn, CURLcode status) if(!status) { /* run the state-machine - TODO: when the multi interface is used, this _really_ should be using - the ssh_multi_statemach function but we have no general support for - non-blocking DONE operations, not in the multi state machine and with - Curl_done() invokes on several places in the code! + This should be using the ssh_multi_statemach function but we have no + support for non-blocking DONE operations! */ result = ssh_block_statemach(conn, FALSE); } diff --git a/lib/telnet.c b/lib/telnet.c index 2086aa396..3975209bd 100644 --- a/lib/telnet.c +++ b/lib/telnet.c @@ -1220,7 +1220,6 @@ CURLcode telrcv(struct connectdata *conn, } /* Escape and send a telnet data block */ -/* TODO: write large chunks of data instead of one byte at a time */ static CURLcode send_telnet_data(struct connectdata *conn, char *buffer, ssize_t nread) { diff --git a/lib/url.c b/lib/url.c index feb4517fc..1be4c2805 100644 --- a/lib/url.c +++ b/lib/url.c @@ -6272,8 +6272,6 @@ CURLcode Curl_do(struct connectdata **connp, bool *done) * second stage DO state which (wrongly) was introduced to support FTP's * second connection. * - * TODO: A future libcurl should be able to work away this state. - * * 'complete' can return 0 for incomplete, 1 for done and -1 for go back to * DOING state there's more work to do! */ diff --git a/lib/vtls/gtls.c b/lib/vtls/gtls.c index 1c1cc2f7b..093cd4e98 100644 --- a/lib/vtls/gtls.c +++ b/lib/vtls/gtls.c @@ -1541,12 +1541,6 @@ static int Curl_gtls_seed(struct SessionHandle *data) if(!ssl_seeded || data->set.str[STRING_SSL_RANDOM_FILE] || data->set.str[STRING_SSL_EGDSOCKET]) { - - /* TODO: to a good job seeding the RNG - This may involve the gcry_control function and these options: - GCRYCTL_SET_RANDOM_SEED_FILE - GCRYCTL_SET_RNDEGD_SOCKET - */ ssl_seeded = TRUE; } return 0; diff --git a/lib/vtls/openssl.c b/lib/vtls/openssl.c index 1cf29764a..ac4bd19be 100644 --- a/lib/vtls/openssl.c +++ b/lib/vtls/openssl.c @@ -2382,11 +2382,6 @@ static CURLcode get_cert_chain(struct connectdata *conn, print_pubkey_BN(dh, priv_key, i); print_pubkey_BN(dh, pub_key, i); break; -#if 0 - case EVP_PKEY_EC: /* symbol not present in OpenSSL 0.9.6 */ - /* left TODO */ - break; -#endif } EVP_PKEY_free(pubkey); } diff --git a/lib/x509asn1.c b/lib/x509asn1.c index a3dfd646b..0cf8ee55b 100644 --- a/lib/x509asn1.c +++ b/lib/x509asn1.c @@ -857,11 +857,6 @@ static void do_pubkey(struct SessionHandle * data, int certnum, do_pubkey_field(data, certnum, "dh(g)", &elem); do_pubkey_field(data, certnum, "dh(pub_key)", &pk); } -#if 0 /* Patent-encumbered. */ - else if(curl_strequal(algo, "ecPublicKey")) { - /* Left TODO. */ - } -#endif } CURLcode Curl_extract_certinfo(struct connectdata * conn, diff --git a/src/tool_cb_prg.c b/src/tool_cb_prg.c index 9e3c5fb4e..e6ec032ab 100644 --- a/src/tool_cb_prg.c +++ b/src/tool_cb_prg.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -117,11 +117,8 @@ void progressbarinit(struct ProgressData *bar, if(config->use_resume) bar->initial_size = config->resume_from; -/* TODO: get terminal width through ansi escapes or something similar. - try to update width when xterm is resized... - 19990617 larsa */ #ifndef __EMX__ - /* 20000318 mgs - * OS/2 users most likely won't have this env var set, and besides that + /* OS/2 users most likely won't have this env var set, and besides that * we're using our own way to determine screen width */ colp = curlx_getenv("COLUMNS"); if(colp) { @@ -136,8 +133,7 @@ void progressbarinit(struct ProgressData *bar, else bar->width = 79; #else - /* 20000318 mgs - * We use this emx library call to get the screen width, and subtract + /* We use this emx library call to get the screen width, and subtract * one from what we got in order to avoid a problem with the cursor * advancing to the next line if we print a string that is as long as * the screen is wide. */ diff --git a/src/tool_operate.c b/src/tool_operate.c index 4a67c0967..31304d460 100644 --- a/src/tool_operate.c +++ b/src/tool_operate.c @@ -116,7 +116,6 @@ CURLcode curl_easy_perform_ev(CURL *easy); static bool is_fatal_error(CURLcode code) { switch(code) { - /* TODO: Should CURLE_SSL_CACERT be included as critical error ? */ case CURLE_FAILED_INIT: case CURLE_OUT_OF_MEMORY: case CURLE_UNKNOWN_OPTION: @@ -856,8 +855,6 @@ static CURLcode operate_do(struct GlobalConfig *global, #if !defined(CURL_DISABLE_PROXY) { - /* TODO: Make this a run-time check instead of compile-time one. */ - my_setopt_str(curl, CURLOPT_PROXY, config->proxy); my_setopt_str(curl, CURLOPT_PROXYUSERPWD, config->proxyuserpwd); @@ -1463,10 +1460,6 @@ static CURLcode operate_do(struct GlobalConfig *global, * file (or terminal). If we write to a file, we must rewind * or close/re-open the file so that the next attempt starts * over from the beginning. - * - * TODO: similar action for the upload case. We might need - * to start over reading from a previous point if we have - * uploaded something when this was returned. */ break; } @@ -1541,8 +1534,6 @@ static CURLcode operate_do(struct GlobalConfig *global, download was not successful. */ long response; if(CURLE_OK == result) { - /* TODO We want to try next resource when download was - not successful. How to know that? */ char *effective_url = NULL; curl_easy_getinfo(curl, CURLINFO_EFFECTIVE_URL, &effective_url); if(effective_url && @@ -1724,9 +1715,6 @@ static CURLcode operate_do(struct GlobalConfig *global, break; mlres = mlres->next; if(mlres == NULL) - /* TODO If metalink_next_res is 1 and mlres is NULL, - * set res to error code - */ break; } else -- cgit v1.2.3