Opened 5 weeks ago

Last modified 25 hours ago

#31176 needs_review enhancement

Teach practracker about .may_include files

Reported by: nickm Owned by: nickm
Priority: Medium Milestone: Tor: 0.4.2.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: practracker, tech-debt, refactoring, easy, 041-deferred-20190530, network-team-roadmap-august
Cc: nickm Actual Points: 1
Parent ID: #29746 Points: 1.5
Reviewer: teor, asn Sponsor: Sponsor31-can

Description

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.

Child Tickets

Change History (5)

comment:1 Changed 5 weeks ago by gaba

Cc: nickm added
Keywords: network-team-roadmap-august added

comment:2 Changed 2 weeks ago by nickm

Actual Points: 1

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.

comment:3 Changed 2 weeks ago by nickm

Status: assignedneeds_review

comment:4 Changed 8 days ago by asn

Reviewer: teor

comment:5 Changed 25 hours ago by teor

Reviewer: teorteor, asn

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

Note: See TracTickets for help on using tickets.