[tor-bugs] #29136 [Core Tor/Tor]: PT_LOG and PT_STATUS event fields unspecifed

[Tor Bug Tracker & Wiki]

#29136: PT_LOG and PT_STATUS event fields unspecifed
--------------------------+------------------------
 Reporter:  atagar        |          Owner:  (none)
     Type:  defect        |         Status:  new
 Priority:  High          |      Milestone:
Component:  Core Tor/Tor  |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:                |  Actual Points:
Parent ID:                |         Points:
 Reviewer:                |        Sponsor:
--------------------------+------------------------

Comment (by teor):

 Replying to [comment:1 atagar]:
 > On a side note I'd appreciate it if the control-spec lists all the event
 fields rather than instructing the reader to see the pt-spec. It's fine to
 cite the pt-spec for information, but when it comes the basic event format
 the control-spec should include everything the reader needs.
 >
 > I watch the control-spec and dir-spec to keep informed about control and
 directory specification changes. Reshuffling event formatting under other
 specs makes my life harder, and arguably makes our control-spec
 incomplete.

 If we duplicate information in control-spec and pt-spec, then they will
 get out of sync. Here's two options to avoid that:
 1. put the relevant information in control-spec, and point pt-spec to
 control-spec
 2. put the basic syntax in control-spec, and then say that additional
 fields may be added, and point to pt-spec for details

 Whatever we decide, we should make sure that we are consistent with our
 other specs.
 For example, the control-spec directory GETINFOs have basic info like URLs
 and descriptions, but the exact format is in dir-spec (like option 2).

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