curl/docs/libcurl/*: fix some formatting of man pages #8365
Conversation
Details: From "mandoc -Tlint": mandoc: curl_getdate.3:64:2: WARNING: skipping paragraph macro: PP empty mandoc: curl_global_init_mem.3:56:2: ERROR: skipping end of block that is not open: RE mandoc: curl_url_cleanup.3:29:2: STYLE: fill mode already enabled, skipping: fi mandoc: curl_url_dup.3:29:2: STYLE: fill mode already enabled, skipping: fi mandoc: curl_url_set.3:32:2: STYLE: fill mode already enabled, skipping: fi From "test-groff -b -mandoc -T utf8 -rF0 -t -w w -z": [ "test-groff" is a developmental version of "groff" ] troff: <curl_getdate.3>:108: warning: trailing space troff: <curl_getdate.3>:109: warning: trailing space Patch originally submitted to Debian at: https://bugs.debian.org/963559
| .BR curl_easy_escape "(3), " curl_easy_unescape "(3), " | ||
| .BR CURLOPT_TIMECONDITION "(3), " CURLOPT_TIMEVALUE "(3) " | ||
| .BR curl_easy_escape "(3), " curl_easy_unescape "(3)," | ||
| .BR CURLOPT_TIMECONDITION "(3), " CURLOPT_TIMEVALUE "(3)" |
There was a problem hiding this comment.
This one puzzles me.
mandoc -Tlint curl_getdate.3on my debian unstable does not warn on this for me- I count a total of 79 similar lines, only counting
.3files in the same directory. Shouldn't then all of them be fixed at the same time?
There was a problem hiding this comment.
This one is not from mandoc, but from test-groff, which is not something I have installed but it makes sense I guess, the finding (from the submitter of the patch) was:
From "test-groff -b -mandoc -T utf8 -rF0 -t -w w -z":
[ "test-groff" is a developmental version of "groff" ]
troff: <curl_getdate.3>:108: warning: trailing space
troff: <curl_getdate.3>:109: warning: trailing space
There's a good chance it can be ignored if you think it's fine (it might be too cosmetic to spend the time to fix across all the files).
There was a problem hiding this comment.
It feels very arbitrary to only fix it in a single file. If we consider this a problem then we should fix it everywhere. If it isn't a problem, then we don't need to fix any file. Why is it a problem? I don't spot any difference at all in the generated result I get with man -l curl_getdate.3.
There was a problem hiding this comment.
Let's drop it then.
I believe this means there's only a single legitimate change to the whole PR, which is for:
mandoc: curl_getdate.3:64:2: WARNING: skipping paragraph macro: PP empty
| @@ -27,7 +27,7 @@ curl_url_cleanup - free a CURLU handle | |||
| #include <curl/curl.h> | |||
|
|
|||
| void curl_url_cleanup(CURLU *handle); | |||
| .fi | |||
| . | |||
There was a problem hiding this comment.
- My mandoc doesn't complain on this
- This pattern is used in all libcurl function man pages, why are these three singled out?
- Why leave a dot?
There was a problem hiding this comment.
Hmm, I also don´t get these anymore, apparently mandoc stopped complaining about it sometime ago.
This hunk can be dropped.
I don't know why the original submitter decided to go with a dot, I wasn't the original reviewer of the patch either so I just kept refreshing it. I figured sending it upstream was a good opportunity to drop changes like this.
|
Thanks! |
Details:
From "mandoc -Tlint":
mandoc: curl_getdate.3:64:2: WARNING: skipping paragraph macro: PP empty
mandoc: curl_global_init_mem.3:56:2: ERROR: skipping end of block that is not open: RE
mandoc: curl_url_cleanup.3:29:2: STYLE: fill mode already enabled, skipping: fi
mandoc: curl_url_dup.3:29:2: STYLE: fill mode already enabled, skipping: fi
mandoc: curl_url_set.3:32:2: STYLE: fill mode already enabled, skipping: fi
From "test-groff -b -mandoc -T utf8 -rF0 -t -w w -z":
[ "test-groff" is a developmental version of "groff" ]
troff: <curl_getdate.3>:108: warning: trailing space
troff: <curl_getdate.3>:109: warning: trailing space
Patch originally submitted to Debian at:
https://bugs.debian.org/963559