[tor-bugs] #32928 [Core Tor/Tor]: Tor Manual: Split Circuit Timeout options into their own subsection

[Tor Bug Tracker & Wiki]

#32928: Tor Manual: Split Circuit Timeout options into their own subsection
-------------------------------------------------+-------------------------
 Reporter:  teor                                 |          Owner:  (none)
     Type:  task                                 |         Status:
                                                 |  needs_review
 Priority:  Medium                               |      Milestone:  Tor:
                                                 |  0.4.3.x-final
Component:  Core Tor/Tor                         |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  documentation tor-client manpage     |  Actual Points:
  easy 043-can extra-review                      |
Parent ID:  #4310                                |         Points:  0.5
 Reviewer:  catalyst, nickm                      |        Sponsor:
-------------------------------------------------+-------------------------

Comment (by catalyst):

 Replying to [comment:13 swati]:

 Thanks for the changes!

 >  - I added a new section called **Dormant Mode Options** and moved the
 four options under this section. Does anyone want to suggest a better
 introductory sentence for this section?

 Dormant mode is a state that tor can enter and leave, and the options in
 this section modify that behavior.  Maybe this?

 "Tor can enter a dormant mode to conserve power and network bandwidth.
 The following options control when tor enters and leaves dormant mode."

 >  - Also, I renamed the Timeout Options section to **Circuit Timeout
 Options**, as suggested by catalyst. I haven't moved the other options
 that aren't directly related to timeout under this section. Leaving them
 where they are for now. Is that okay?

 I think that's fine.  I couldn't come up with a concise heading for an
 expanded section that would contain the other options you were
 considering.  I would suggest rewording the introductory paragraph to
 something like this?

 "The following options are useful for configuring timeouts related to
 building Tor circuits and using them."

 >  - Can we consider this ticket resolved? If yes, can we merge the PR so
 that I can continue working on the rest of the manual?

 I think we're mostly there.  There are a couple of minor wording changes I
 suggested above for the introductory text of the new sections.  If you
 agree, please go ahead and make those changes.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/32928#comment:15>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online