Re: [tor-bugs] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  documentation tor-client manpage |  Actual Points:
  easy 043-can   |
Parent ID:  #4310| Points:  1
 Reviewer:   |Sponsor:
-+-

Comment (by teor):

 Replying to [comment:5 atagar]:
 > Hi teor. Sorry, unsure I follow - if a stem integ test it would be
 included under tor's stem testing target.

 Yes, that's true, we run the stem tests in Tor's CI.

 But we don't run them during "make check".

 > Alphabetisation doesn't seem critical enough to warrant the hassle of a
 pre-commit hook but up to you folks.

 We have an existing pre-commit hook that runs most of our simple checks.

 The final design is totally up to the author and reviewer. I think
 catalyst has been doing some work here, so I'm happy to leave it to them.

--
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] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  documentation tor-client manpage |  Actual Points:
  easy 043-can   |
Parent ID:  #4310| Points:  1
 Reviewer:   |Sponsor:
-+-

Comment (by atagar):

 Hi teor. Sorry, unsure I follow - if a stem integ test it would be
 included under tor's stem testing target. Alphabetisation doesn't seem
 critical enough to warrant the hassle of a pre-commit hook but up to you
 folks.

--
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] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  documentation tor-client manpage |  Actual Points:
  easy 043-can   |
Parent ID:  #4310| Points:  1
 Reviewer:   |Sponsor:
-+-

Comment (by teor):

 If we're going to automate these checks, they should go in:
 * the `make check` target, and
 * the pre-commit git hook.

 Since we can't be sure if stem is installed, it might be a good idea to
 avoid a dependency on stem.

 If we do need to depend on stem, we should skip the tests (without
 failure) if stem is not installed.

--
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] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  documentation tor-client manpage |  Actual Points:
  easy 043-can   |
Parent ID:  #4310| Points:  1
 Reviewer:   |Sponsor:
-+-
Changes (by ahf):

 * keywords:  documentation tor-client manpage easy => documentation tor-
 client manpage easy 043-can


--
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] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  documentation tor-client manpage |  Actual Points:
  easy   |
Parent ID:  #4310| Points:  1
 Reviewer:   |Sponsor:
-+-

Comment (by atagar):

 Stem provides a module to read tor's man page. Actually, we **already**
 have tests for its content...

 https://gitweb.torproject.org/stem.git/tree/stem/manual.py
 https://gitweb.torproject.org/stem.git/tree/test/integ/manual.py

 If you'd care to check for alphabetization this is likely the best spot to
 do so.

--
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] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.3.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  documentation tor-client manpage |  Actual Points:
  easy   |
Parent ID:  #4310| Points:  1
 Reviewer:   |Sponsor:
-+-

Comment (by catalyst):

 I looked briefly at Python's diffutils library and it seems plausible as a
 basis for such a tool.

 We'd need some easily-parsed way to mark exceptions, and maybe some way to
 double-check that the anchors names match their item names. (Also we
 should skip the "formatting only" anchors.)

--
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] #32621 [Core Tor/Tor]: Add automated checks to make sure man page options stay in alphabetical order

[Tor Bug Tracker & Wiki]

#32621: Add automated checks to make sure man page options stay in alphabetical
order
-+-
 Reporter:  teor |  Owner:  (none)
 Type:  task | Status:  new
 Priority:  Medium   |  Milestone:  Tor: 0.4.3.x-final
Component:  Core |Version:
  Tor/Tor|   Keywords:  documentation tor-client manpage
 Severity:  Normal   |  easy
Actual Points:   |  Parent ID:  #4310
   Points:  1|   Reviewer:
  Sponsor:   |
-+-
 We should add automated checks or automated tooling that makes sure that
 the man page options are in alphabetical order (within sections).

 These tools will help us not regress #4310.

--
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