[tor-bugs] #32619 [Core Tor]: fix syntax errors in torspec documents

Tor Bug Tracker & Wiki blackhole at torproject.org
Tue Nov 26 22:07:11 UTC 2019


#32619: fix syntax errors in torspec documents
-----------------------+--------------------------
 Reporter:  eighthave  |          Owner:  (none)
     Type:  defect     |         Status:  new
 Priority:  Medium     |      Component:  Core Tor
  Version:             |       Severity:  Normal
 Keywords:  torspec    |  Actual Points:
Parent ID:             |         Points:
 Reviewer:             |        Sponsor:
-----------------------+--------------------------
 https://github.com/torproject/torspec/pull/95 fixes a handful of errors in
 the syntax of things like the title line and the section names.  That
 makes these files much more machine readable.  All of the changes here are
 trivial.

 With these changes, then a script can convert these files to a nice
 collection of HTML pages in a CI job that takes less than a minute to run:
 * https://gitlab.com/eighthave/torspec/-/jobs/362125193
 * https://eighthave.gitlab.io/torspec/

 This provides nice features like links to sections based on the section
 name:
 * https://eighthave.gitlab.io/torspec/control-spec.html#hsfetch
 * https://eighthave.gitlab.io/torspec/control-spec.html#circuit-status-
 changed
 * https://eighthave.gitlab.io/torspec/tor-spec.html#tls-security-
 considerations

 Using GitLab CI, this could easily rsync the result to any webserver.

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


More information about the tor-bugs mailing list