Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs/libcurl: fix three minor man page format mistakes #12126

Closed
wants to merge 1 commit into from
Closed

docs/libcurl: fix three minor man page format mistakes #12126

wants to merge 1 commit into from
+4 −4

Conversation

charles2910
Copy link
Contributor

Hi there,

After the last upload of curl to Debian (8.4.0), samueloph noticed some lintian warnings about the manpages:

W: libcurl4-doc: groff-message troff:<standard input>:106: warning: macro '..' not defined [usr/share/man/man3/curl_global_trace.3.gz:1]
W: libcurl4-doc: groff-message troff:<standard input>:119: warning: macro 'BR' not defined [usr/share/man/man3/curl_getdate.3.gz:4]
W: libcurl4-doc: groff-message troff:<standard input>:25: warning: macro 'SH' not defined [usr/share/man/man3/curl_getdate.3.gz:1]
W: libcurl4-doc: groff-message troff:<standard input>:46: warning: macro 'TP' not defined [usr/share/man/man3/curl_getdate.3.gz:2]
W: libcurl4-doc: groff-message troff:<standard input>:47: warning: macro 'B' not defined [usr/share/man/man3/curl_getdate.3.gz:3]
W: libcurl4-doc: groff-message troff:<standard input>:64: warning: macro 'BN' not defined [usr/share/man/man3/CURLOPT_PROXY_TRANSFER_MODE.3.gz:1]
W: libcurl4-doc: groff-message troff:<standard input>:75: warning: expected numeric expression, got 'd' [usr/share/man/man3/libcurl.3.gz:1]

He asked me to take a look at it (I'm currently helping him a bit with packaging), so here we are. One problem was fixed already by e2006b5, but the others are still there and this commit fix them.

Note that lintian itself gave me a hint:

The check for manual pages uses the --warnings option to man to catch common problems, like a . or a ' at the beginning of a line as literal text. They are interpreted as Groff commands. Just reformat the paragraph so the characters are not at the beginning of a line. You can also add a zero-width space (&) in front of them.

This is my first contribution to curl, so I might have done things improperly. Please let me know if I should correct anything.

@charles2910
docs/libcurl: fix three minor man page format mistakes
de61296 
The altered files are:

- curl_getdate.3
- curl_global_trace.3
- libcurl.3
@jay jay closed this in e4de693 Oct 15, 2023
@jay
Copy link
Member

jay commented Oct 15, 2023

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation hacktoberfest-accepted libcurl API
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@charles2910 @jay