[tor-bugs] #22827 [Core Tor/Tor]: Formalise CollecTor spec for sanitised bridge descriptors and put in torspec

[Tor Bug Tracker & Wiki]

#22827: Formalise CollecTor spec for sanitised bridge descriptors and put in
torspec
---------------------------------------------+-----------------------------
 Reporter:  isis                             |          Owner:  karsten
     Type:  enhancement                      |         Status:
                                             |  needs_review
 Priority:  Medium                           |      Milestone:  Tor:
                                             |  unspecified
Component:  Core Tor/Tor                     |        Version:
 Severity:  Normal                           |     Resolution:
 Keywords:  tor-spec, tor-docs, tor-bridges  |  Actual Points:
Parent ID:                                   |         Points:
 Reviewer:                                   |        Sponsor:
---------------------------------------------+-----------------------------

Comment (by iwakeh):

 Replying to [comment:16 karsten]:
 > Thanks for the review!
 >
 > Replying to [comment:15 iwakeh]:
 > > According to
 [https://trac.torproject.org/projects/tor/wiki/org/teams/MetricsTeam/MetricsJavaStyleGuide#FileStructureofJavaProjects
 our project structure] I'd prefer to have the folder `spec` in
 `src/main/resources`.
 >
 > Ah, you mean move from `src/main/spec/` to `src/main/resources/spec/`?
 Sure.

 Thanks!

 >
 > > The saxon-packages I can find in debian jessie or stretch only supply
 `saxon-xslt`, but that doesn't work either when calling `convert.sh`.
 What could be amiss?
 >
 > Ah, the reason is probably that I'm using the Saxon that comes with
 brew, not the one in Debian. I'll create a symlink here and change it in
 the script.

 There might be more to it:
 Running `convert.sh` leads to:
 {{{
 website/src/main/resources/spec$ ./convert.sh
 INFO: unsupported rfc pseudo-attribute 'topblock'
 line 359 column 700 - Error: <header> is not recognized!
 line 359 column 700 - Warning: discarding unexpected <header>
 line 359 column 765 - Warning: discarding unexpected </header>
 line 359 column 774 - Error: <section> is not recognized!
 line 359 column 774 - Warning: discarding unexpected <section>
 line 359 column 2004 - Warning: discarding unexpected </section>
 line 359 column 2014 - Error: <section> is not recognized!
 line 359 column 2014 - Warning: discarding unexpected <section>
 line 359 column 2391 - Error: <section> is not recognized!
 line 359 column 2391 - Warning: discarding unexpected <section>
 line 359 column 3031 - Warning: discarding unexpected </section>
 line 359 column 3041 - Error: <section> is not recognized!
 line 359 column 3041 - Warning: discarding unexpected <section>
 line 359 column 4039 - Warning: discarding unexpected </section>
 line 359 column 4049 - Error: <section> is not recognized!
 }}}
 and only a zero byte file 'bridge-descriptors.jsp'.

 >
 > > The 'things left to do' seems complete (except for making the process
 work).
 > >
 > > And, the screenshot looks fine :-)
 >
 > Okay, cool! I made the remaining edits and pushed a few more commits to
 [https://gitweb.torproject.org/karsten/metrics-web.git/log/?h=task-22827
 my task-22827 branch].
 >
 > I'd like to squash these commits into one for the new specification
 content and another one for the RFC files. Do you mind?
 >
 > After that I'll merge into master and deploy.

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