#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
---------------------------------------+--------------------------------
Comment (by acute):
Replying to [comment:4 phw]:
> 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.
The patch looks good, I think this can be merged!
>
> 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.
These two were intended to serve different purposes. The readme was meant
to be a quick reference, and the docs an in-depth guide which includes
module documentation (sphinx autodoc can be used to build documentation
from docstrings) and more exotic deployment options (for say,
researchers). The docs are currently served here:
https://onionperf.torproject.org
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/33435#comment:5>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs
