Portions of the tor.1 man page and html doc formatted incorrectly
Some portions of the tor.1 doc don't join paragraphs correctly, leading to strange output styles, especially in html view, which appears to default to
blocks when asciidoc is confused by the syntax.Trac:
Username: jryans
- Show closed items
Activity
-
Newest first Oldest first
-
Show all activity Show comments only Show history only
- Trac changed milestone to %Tor: 0.3.0.x-final in legacy/trac
changed milestone to %Tor: 0.3.0.x-final in legacy/trac
- Trac added component::core tor/tor in Legacy / Trac doc in Legacy / Trac man in Legacy / Trac milestone::Tor: 0.3.0.x-final in Legacy / Trac owner::jryans in Legacy / Trac priority::medium in Legacy / Trac reporter::jryans in Legacy / Trac resolution::fixed in Legacy / Trac review-group-14 in Legacy / Trac severity::normal in Legacy / Trac status::closed in Legacy / Trac type::defect in Legacy / Trac labels
added component::core tor/tor in Legacy / Trac doc in Legacy / Trac man in Legacy / Trac milestone::Tor: 0.3.0.x-final in Legacy / Trac owner::jryans in Legacy / Trac priority::medium in Legacy / Trac reporter::jryans in Legacy / Trac resolution::fixed in Legacy / Trac review-group-14 in Legacy / Trac severity::normal in Legacy / Trac status::closed in Legacy / Trac type::defect in Legacy / Trac labels
Patch available at https://github.com/jryans/tor/commits/doc-formatting.
Trac:
Username: jryans
Status: assigned to needs_review- Owner
Thanks jryans! Question:
Why
SocksPortFlagsMisc
andExitPolicyDefault
andORPortFlagsExclusive
don't show in the generated man page or HTML? So what are they for?I'm asking because those could be confused with torrc option so I would be careful not to introduce section title that looks like such :S.
Trac:
Keywords: N/A deleted, man doc added
Status: needs_review to needs_information
Milestone: Tor: 0.3.??? to Tor: 0.3.0.x-final Sorry, I should have explained that up front!
These "fake" sections were the only way I could see to have a paragraph be indented in the style of a first-level list item when it comes after a second-level / nested list item. All the other approaches I attempted led to the paragraph glued onto the content of the last second-level list item or formatted as a code sample, both of which are not what's intended. (There seems to be no explicit way to "end" the second-level list, so you have to find some way to trigger that implicitly. asciidoc is strange.)
I noticed there is a pre-existing usage of this technique with
OtherSocksPortFlags
. So anyway, these sections could really be named anything, since they don't appear in the output. Any suggestions for less confusing names, or do they seem okay?Trac:
Username: jryans
Status: needs_information to needs_review- Owner
Trac:
Keywords: man doc deleted, man, doc, review-group-14 added - Owner
This looks good to me. Merging; thanks!
Trac:
Resolution: N/A to fixed
Status: needs_review to closed - Trac closed
closed
- Damian Johnson mentioned in issue legacy/trac#25582 (moved)
mentioned in issue legacy/trac#25582 (moved)
- Trac moved from legacy/trac#20885 (moved)
moved from legacy/trac#20885 (moved)
- Trac added 1 deleted label and removed 1 deleted label
added 1 deleted label and removed 1 deleted label
- Gaba added Documentation label and removed 1 deleted label
added Documentation label and removed 1 deleted label