Re: [tor-bugs] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:  closed
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:  fixed
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-
Changes (by dgoulet):

 * status:  merge_ready => closed
 * resolution:   => fixed


Comment:

 Merged! Thanks!

--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  merge_ready
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-

Comment (by nickm):

 There are merge conflicts so I made a branch called `ticket31176_merged`
 with PR at https://github.com/torproject/tor/pull/1245

--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  merge_ready
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-
Changes (by dgoulet):

 * status:  needs_review => merge_ready


--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-
Changes (by nickm):

 * status:  needs_revision => needs_review


--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  needs_revision
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-

Comment (by nickm):

 I agree with all of your suggestions here, but I am wondering if I can do
 them in a new branch after this is merged.

 The issue is that the current PR (for #31176) is based on an older version
 of practracker that did not support header files (#31175) and which did
 not have integration test support (#31263).

 We should document header files as well as includes, and we should use the
 test support to test all of this.

 I've made a new ticket  (#31476) for the documentation, and another for
 the new tests (#31477).  Okay to merge this?

--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  needs_revision
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-
Changes (by asn):

 * status:  needs_review => needs_revision


Comment:

 Design looks reasonable.

 We should update the file-level comment of practracker.py to mention that
 we are now checking for include dependecies too. Same goes for the header
 of exceptions.txt .

 And maybe it's time to make a small README file to specify all the metrics
 that practracker is currently looking for, before they become too many?

 Also, I wonder if we should be requiring unittests for practracker
 features.

--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor, asn|Sponsor:
 |  Sponsor31-can
-+-
Changes (by teor):

 * reviewer:  teor => teor, asn


Comment:

 Looks fine to me, but I think asn knows more about practracker, and can
 give it a better review.

--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:  teor |Sponsor:
 |  Sponsor31-can
-+-
Changes (by asn):

 * reviewer:   => teor


--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  needs_review
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:   |Sponsor:
 |  Sponsor31-can
-+-
Changes (by nickm):

 * status:  assigned => needs_review


--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  assigned
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:  1
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:   |Sponsor:
 |  Sponsor31-can
-+-
Changes (by nickm):

 * actualpoints:   => 1


Comment:

 See branch `ticket31176` with PR in
 https://github.com/torproject/tor/pull/1206 .

 This branch comes in two main parts.  In the first part, I refactor
 checkIncludes.py until it can be integrated into practracker.  In the
 second, I move checkIncludes.py to practracker/includes.py, and teach it
 that some violations are "advisory only" -- to be counted as best-
 practices violations, but not to cause build failures.

 I've added .may_include files to src/core/* for this, since that is where
 we currently most want to push the modularity boundary.

--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:  enhancement  | Status:
 |  assigned
 Priority:  Medium   |  Milestone:  Tor:
 |  0.4.2.x-final
Component:  Core Tor/Tor |Version:
 Severity:  Normal   | Resolution:
 Keywords:  practracker, tech-debt,  |  Actual Points:
  refactoring, easy, 041-deferred-20190530,  |
  network-team-roadmap-august|
Parent ID:  #29746   | Points:  1.5
 Reviewer:   |Sponsor:
 |  Sponsor31-can
-+-
Changes (by gaba):

 * cc: nickm (added)
 * keywords:  practracker, tech-debt, refactoring, easy,
 041-deferred-20190530 =>
 practracker, tech-debt, refactoring, easy, 041-deferred-20190530,
 network-team-roadmap-august


--
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] #31176 [Core Tor/Tor]: Teach practracker about .may_include files

[Tor Bug Tracker & Wiki]

#31176: Teach practracker about .may_include files
-+-
 Reporter:  nickm|  Owner:  nickm
 Type:   | Status:  assigned
  enhancement|
 Priority:  Medium   |  Milestone:  Tor: 0.4.2.x-final
Component:  Core |Version:
  Tor/Tor|   Keywords:  practracker, tech-debt,
 Severity:  Normal   |  refactoring, easy, 041-deferred-20190530
Actual Points:   |  Parent ID:  #29746
   Points:  1.5  |   Reviewer:
  Sponsor:   |
  Sponsor31-can  |
-+-
 We would like to introduce a second category of .may_include rules: those
 that should only apply on an advisory basis.  We would treat violations of
 these rules as a best practices violation rather than an error.  It would
 allow us to start ratcheting down the number of layering violations.

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