[tor-bugs] #8964 [Tor]: doc/HACKING is out of date

[Tor Bug Tracker & Wiki]

#8964: doc/HACKING is out of date
---------------------+------------------------------------------------------
 Reporter:  rransom  |          Owner:     
     Type:  defect   |         Status:  new
 Priority:  trivial  |      Milestone:     
Component:  Tor      |        Version:     
 Keywords:           |         Parent:     
   Points:           |   Actualpoints:     
---------------------+------------------------------------------------------
 (as of commit e7134c2375f3c577ab7dcc20c74c5773d1a5f37d)

 Line 43 states that the maint-0.2.1 branch is currently ‘actively
 developed’.  It should not.

 Line 54 uses “bug 9999” as a dummy bug number.  That ticket will be opened
 this year.

 Line 96 refers to “https://buildbot.vidalia-
 project.net/one_line_per_build”.  I don't believe that that URL is still
 valid.

 The Doxygen formatting details (starting after line 329) are frequently
 ignored in practice.  That's probably a good thing, because fewer
 developers use Doxygen than jump around in the source using TAGS files and
 grep and read the comments directly.  If you don't agree that abandoning
 Doxygen is a good idea, `make check-spaces` should detect and complain
 about at least gross problems (e.g. characters that should be escaped left
 unescaped).

 The HACKING file does not mention using a TAGS file.  (I put “`find src/
 -name '*.[hc]' |etags -`” in my Git post-checkout hook.)

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