Skip to content

tidy-up: comments, messages, formatting - #22443

Closed
vszakats wants to merge 16 commits into
curl:masterfrom
vszakats:tidy2
Closed

tidy-up: comments, messages, formatting#22443
vszakats wants to merge 16 commits into
curl:masterfrom
vszakats:tidy2

Conversation

@vszakats

@vszakats vszakats commented Jul 30, 2026

Copy link
Copy Markdown
Member
  • 'null-terminate', sync casing.
  • add an #endif comment.
  • avoid a few instances of 'will'.
  • configure: 'aws' → 'aws-sigv4', where missing.
  • unfold/fold lines.
  • update memzero/strzero comments.
  • uppercase 'CRLF'.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR is a repository-wide tidy-up focused on improving wording consistency in comments/messages and standardizing formatting (case, line wrapping) across code, tests, docs, and build scripts.

Changes:

  • Standardize terminology/casing in comments (e.g., “CRLF”, “null-terminate”) and adjust wording to avoid “will”.
  • Reflow/unwrap various long lines (function signatures, (void) casts, docs examples) for readability.
  • Clarify/rename AWS-related configure help text to “aws-sigv4” where applicable.

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tests/server/tftpd.c Comment casing standardized to “CRLF”.
tests/negtelnetserver.py Minor wording change in an explanatory comment.
tests/ftpserver.pl Adjusted log wording and a nearby comment.
src/tool_doswin.c Minor comment wording/formatting tweak.
README Minor wording change in clone instructions.
projects/vms/curl_crtl_init.c Comment casing synced (“null-terminate”).
projects/OS400/os400sys.c Added #endif comment for clarity.
lib/vauth/ntlm.c Comment casing and alignment adjustment in NTLM structure docs.
lib/smtp.c Standardized comment to “CRLF”.
lib/sendf.c Standardized comment to “CRLF”.
lib/pop3.c Standardized comment to “CRLF”.
lib/ftp.c Standardized comment to “CRLF”.
lib/escape.c Comment casing synced (“null-terminated”).
lib/curlx/strdup.c Updated memzero/strzero comments to match behavior.
lib/curlx/base64.c Comment casing synced (“null-terminate”).
lib/curl_gssapi.c Reflowed stub function signature formatting.
lib/curl_ed25519.c Expanded (void) casts onto separate lines for readability.
docs/libcurl/opts/CURLOPT_HTTPSIG_KEYID.md Reflowed example curl_easy_setopt line.
docs/libcurl/opts/CURLOPT_HTTPSIG_KEY.md Reflowed example curl_easy_setopt line.
docs/libcurl/opts/CURLOPT_HTTPSIG_HEADERS.md Reflowed example curl_easy_setopt line.
docs/libcurl/opts/CURLOPT_HTTPSIG_ALGORITHM.md Reflowed example curl_easy_setopt line.
configure.ac Updated TLS error message wording and AWS help-text wording.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread configure.ac Outdated
Comment thread tests/ftpserver.pl Outdated

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (6)

tests/ftpserver.pl:2578

  • This log line’s new wording (“upcoming DATA connection is accepted”) sounds like the connection is already accepted; the previous text communicated intent/future behavior. Consider using “can be accepted” to keep the original meaning without “will”.
    logmsg "Client has been notified that upcoming DATA connection ".
           "is accepted on port $pasvport\n";

configure.ac:2156

  • This configure-time error message reads awkwardly (“cannot build with HTTPS…”). Consider wording it as “cannot enable …” (since configure is failing because TLS support is missing) while still avoiding “you will”.
    AC_MSG_ERROR([TLS not detected, cannot build with HTTPS, FTPS, NTLM and more.

lib/escape.c:199

  • The Curl_hexencode() doc comment line is a sentence fragment and now starts with lowercase; it would be clearer and grammatically correct as a full sentence while keeping the preferred lowercase “null-terminated”.
 * null-terminated.

tests/ftpserver.pl:2768

  • This comment is grammatically awkward (“is not able”). Consider “is unable …” (and add “a” before “data connection”).
        # client is not able to establish data connection.

lib/vauth/ntlm.c:558

  • The spacing in this message-structure table row looks off compared to the surrounding aligned columns (extra space before “security buffer”).
           36    username               security buffer

README:44

  • The new README wording is grammatically awkward (“you get a directory … created”). Consider rephrasing to a passive construction while keeping the shorter tense.
  (you get a directory named curl created, filled with the source code)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated no new comments.

@vszakats vszakats closed this in c4013cd Jul 30, 2026
@vszakats
vszakats deleted the tidy2 branch July 30, 2026 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants