Some doc fixes #6630
Some doc fixes #6630
Conversation
richsalz
added
branch: master
doc/man1/openssl.pod
Outdated
| @@ -77,161 +77,161 @@ B<list>, or B<no->I<XXX> itself.) | |||
|
|
|||
| =over 4 | |||
|
|
|||
| =item L<B<asn1parse>|asn1parse(1)> | |||
| =item L<asn1parse(1)> | |||
There was a problem hiding this comment.
I would prefer this:
=item B<asn1parse>
(and not just for this one)
There was a problem hiding this comment.
But we want the '(1)' to refer to the man1 section. Look at all the other L<> references, such as the SEE ALSO sections.
There was a problem hiding this comment.
What about the message digest and the encoding and cipher commands?
The SEE ALSO section is different, you'd expect links there.
I think these were formatted like they were so the itemized subcommands would have direct links to their pages in html, but would otherwise look like subcommands, not like manpage references.
There was a problem hiding this comment.
And, in retrospect, you were right to do so. Additional commit pushed. (all will be squashed)
doc/man1/ts.pod
Outdated
| @@ -288,7 +288,7 @@ to the output file. This option does not require a request, it is | |||
| useful e.g. when you need to examine the content of a response or | |||
| token or you want to extract the time stamp token from a response. If | |||
| the input is a token and the output is a time stamp response a default | |||
| 'granted' status info is added to the token. (Optional) | |||
| "granted" status info is added to the token. (Optional) | |||
There was a problem hiding this comment.
Any special reason for this change? If you really want this change, maybe you should change all instances of single quotes (watch out do you don't change an apostrophe)
There was a problem hiding this comment.
In roff, a single quote at the start of a line is just like a period -- it's a macro invocation -- however pod2man does escape it properly. This was a holdover from the previous PR, and I will update the commit to remove it.
|
I'm going to wait on merging this (@paulidale approved it) until @levitte is okay with it. |
levitte
added
approval: done
Also fix some L<> labels and =item entries found while doing this. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from #6630)
|
Merged, thanks for the feedback/improvements. |
Fixes #6606.
Also, fixed some L<> style errors that I found.
Not going to backport.