[tor-bugs] #33435 [Metrics/Onionperf]: Document BASETORRC environment variable

Tor Bug Tracker & Wiki blackhole at torproject.org
Fri May 15 21:48:51 UTC 2020


#33435: Document BASETORRC environment variable
---------------------------------------+--------------------------------
 Reporter:  acute                      |          Owner:  phw
     Type:  enhancement                |         Status:  needs_review
 Priority:  Medium                     |      Milestone:
Component:  Metrics/Onionperf          |        Version:
 Severity:  Normal                     |     Resolution:
 Keywords:  metrics-team-roadmap-2020  |  Actual Points:
Parent ID:                             |         Points:  0.2
 Reviewer:                             |        Sponsor:  Sponsor59-must
---------------------------------------+--------------------------------
Changes (by phw):

 * status:  assigned => needs_review


Comment:

 Here's a patch that documents `BASETORRC` in the file
 onionperf/docs/onionperf.rst:
 https://github.com/NullHypothesis/onionperf/compare/enhancement/33435

 The patch also adds a table of contents to onionperf's README, which makes
 it easier to browse.

 I wonder if we should merge README.md with onionperf.rst. The two files
 contain redundant installation instructions and I found it confusing that
 more documentation was hidden in the source code directory.

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


More information about the tor-bugs mailing list