Document how to edit practracker exception files

It's really not clear how I should edit practracker exception files.

We should update the documentation at the start of practracker.py, update the warning message logged by practracker.py, and maybe update HelpfulTools.md.

Marking this as 040-must, because it's blocking merges.

changed milestone to %Tor: 0.4.1.x-final

Trac:
Child Ticket(s): #29912 (moved)

added 040-must actualpoints::.2 component::core tor/tor milestone::Tor: 0.4.1.x-final owner::nickm points::0.2 priority::high resolution::implemented severity::normal status::closed type::defect labels

Not sure if I will have time to do this in March. Perhaps someone else can take it.

Trac:
Owner: N/A to nickm
Status: new to accepted
Priority: Medium to High

I've made a branch called practracker_regen to do this, and to have a make target for regenerating the exceptions file. The PR is https://github.com/torproject/tor/pull/843 . We should probably merge this along with #29882 (moved).

Trac:
Actualpoints: N/A to .2
Status: accepted to needs_review

These comments at the start of practracker.py are now outdated:

practracker.py should be run with its second argument pointing to the Tor
top-level source directory like this:
  $ python3 ./scripts/maint/practracker/practracker.py .
The exceptions file is meant to be initialized once with the current state of
the source code and then get saved in the repository for ever after:
  $ python3 ./scripts/maint/practracker/practracker.py . > ./scripts/maint/practracker/exceptions.txt

Do we also need to update HelpfulTools.md?

Trac:
Status: needs_review to needs_revision

Should we regenerate the practracker exceptions file in this branch? If we commit the new stable sort order now, future regenerations will have cleaner diffs.

Let's not regenerate until after #29894 (moved) is merged -- it will save us some conflicts.

I've tweaked the comment at the head of the file.

Trac:
Status: needs_revision to needs_review

Replying to nickm:

Let's not regenerate until after #29894 (moved) is merged -- it will save us some conflicts.

#29894 (moved) is now merged (thanks, asn!). Let's regenerate once this branch is merged too.

Ok, I am happy with this ticket.

I will open child tickets for the remaining issues.

Trac:
Status: needs_review to merge_ready

I've merged the branch to master.

Un-parented open child, so we can close.

Trac:
Status: merge_ready to closed
Resolution: N/A to implemented

closed

changed time estimate to 1h 36m

added 1h 36m of time spent

mentioned in issue #29911 (moved)

mentioned in issue #29912 (moved)

moved to tpo/core/tor#29884 (closed)