Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:  closed
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  implemented
  s31-docs   |  Actual Points:  .2
Parent ID:  #29215   | Points:
 Reviewer:  catalyst |Sponsor:
 |  Sponsor31-must
-+-
Changes (by nickm):

 * status:  needs_review => closed
 * resolution:   => implemented


Comment:

 Okay. I've updated and merged this branch.  Thanks!

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:  .2
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:  catalyst |Sponsor:
 |  Sponsor31-must
-+-

Comment (by catalyst):

 Replying to [comment:7 nickm]:
 > Replying to [comment:6 catalyst]:
 > > We might want to explain why we would want to add new fields in the
 middle of `subsys_fns_t`.
 >
 > I don't understand -- as opposed to at the end of it?  Or why we'd add
 new fields at all?
 Yes, as opposed to at the end. Hm, given that this is justifying asking
 people to use named initializers, maybe we should also say that they help
 with code readability when many pointers need to be null? Also, I'm
 guessing that sometimes there are reasons to keep a logical grouping of
 fields together? (I'm pretty sure we're not optimizing for storage layout
 here given the existing order of fields in the structure.)

 > > As a minor style nit, do we need to use backslashes for Doxygen
 commands in that places you use them here? I would like us to move towards
 more consistently using at-signs for Doxygen commands.
 >
 > I'm okay trying to remember to use @ signs in the future, but I'd rather
 not adopt a rule forcing them without tooling to convert and enforce. Does
 that sound okay?
 Yes. I'm happy if we adopt a guideline (not requirement) to prefer at-
 signs for Doxygen commands in new Doxygen comments.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:  .2
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:  catalyst |Sponsor:
 |  Sponsor31-must
-+-

Comment (by nickm):

 Replying to [comment:6 catalyst]:
 > Replying to [comment:3 nickm]:
 > > See branch `ticket32211` for a small first draft here. I imagine that
 more documentation is probably desirable; any guidance would be welcome.
 PR at https://github.com/torproject/tor/pull/1520
 > Thanks! Looks good so far. What areas do you think need more work?

 I don't know, TBH.  I'm hoping that there will be questions I can answer
 more about.

 > We might want to explain why we would want to add new fields in the
 middle of `subsys_fns_t`.

 I don't understand -- as opposed to at the end of it?  Or why we'd add new
 fields at all?


 > In `initialization.dox`, maybe move the reference to `subsys_fns_t`
 closer to the beginning of that paragraph? Maybe like
 >
 > > `subsys_fns_t` describes a subsystem and a set of functions [...] To
 define a subsystem...

 Sounds good.

 > As a minor style nit, do we need to use backslashes for Doxygen commands
 in that places you use them here? I would like us to move towards more
 consistently using at-signs for Doxygen commands.

 I'm okay trying to remember to use @ signs in the future, but I'd rather
 not adopt a rule forcing them without tooling to convert and enforce. Does
 that sound okay?

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:  .2
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:  catalyst |Sponsor:
 |  Sponsor31-must
-+-

Comment (by catalyst):

 Replying to [comment:3 nickm]:
 > See branch `ticket32211` for a small first draft here. I imagine that
 more documentation is probably desirable; any guidance would be welcome.
 PR at https://github.com/torproject/tor/pull/1520
 Thanks! Looks good so far. What areas do you think need more work?

 We might want to explain why we would want to add new fields in the middle
 of `subsys_fns_t`.

 In `initialization.dox`, maybe move the reference to `subsys_fns_t` closer
 to the beginning of that paragraph? Maybe like

 > `subsys_fns_t` describes a subsystem and a set of functions [...] To
 define a subsystem...

 As a minor style nit, do we need to use backslashes for Doxygen commands
 in that places you use them here? I would like us to move towards more
 consistently using at-signs for Doxygen commands.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:  .2
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:  catalyst |Sponsor:
 |  Sponsor31-must
-+-
Changes (by asn):

 * reviewer:   => catalyst


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:
 |  assigned
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:   |Sponsor:
 |  Sponsor31-must
-+-

Comment (by nickm):

 See branch `ticket32211` for a small first draft here. I imagine that more
 documentation is probably desirable; any guidance would be welcome. PR at
 https://github.com/torproject/tor/pull/1520

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  task | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:  .2
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:   |Sponsor:
 |  Sponsor31-must
-+-
Changes (by nickm):

 * status:  assigned => needs_review
 * actualpoints:   => .2


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:  catalyst |  Owner:  nickm
 Type:  defect   | Status:
 |  assigned
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  network-team-roadmap-september,  |  Actual Points:
  s31-docs   |
Parent ID:  #29215   | Points:
 Reviewer:   |Sponsor:
 |  Sponsor31-must
-+-
Changes (by catalyst):

 * status:  new => assigned
 * owner:  (none) => nickm


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

[tor-bugs] #32211 [Core Tor/Tor]: write description of subsystem initialization/shutdown architecture

[Tor Bug Tracker & Wiki]

#32211: write description of subsystem initialization/shutdown architecture
-+-
 Reporter:   |  Owner:  (none)
  catalyst   |
 Type:  defect   | Status:  new
 Priority:  Medium   |  Milestone:  Tor: 0.4.3.x-final
Component:  Core |Version:
  Tor/Tor|   Keywords:  network-team-roadmap-september,
 Severity:  Normal   |  s31-docs
Actual Points:   |  Parent ID:  #29215
   Points:   |   Reviewer:
  Sponsor:   |
  Sponsor31-must |
-+-


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs