Document BASETORRC environment variable

OP can configure the Tor client through the BASETORRC environment variable. This should be added to the documentation with examples.

Trac:
Parent Ticket: #33321 (moved)

added actualpoints::0.2 component::metrics/onionperf metrics-team-roadmap-2020 owner::phw parent::33321 points::0.2 priority::medium resolution::fixed severity::normal sponsor::59-must status::closed type::enhancement labels

Trac:
Points: N/A to 0.2
Keywords: N/A deleted, metrics-team-roadmap-2020 added
Sponsor: N/A to Sponsor59

Moving to Sponsor59-must, because we should really do these in order to call Sponsor59 done.

Trac:
Sponsor: Sponsor59 to Sponsor59-must

Trac:
Status: new to assigned
Owner: metrics-team to 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.

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.

Trac:
Status: assigned to needs_review

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

Adding my 0.1 points to yours.

Trac:
Status: needs_review to merge_ready
Points: 0.2 to 0.3

Oh, I hadn't seen that this is ready to be merged. I guess we need to copy metrics-team in order to get updates sent to metrics-bugs@.

Rebased and pushed to master!

I agree that having documentation in several places is a bit confusing. That is on my list, but I'll create a ticket to discuss any changes before making them.

Moving acute's 0.2 actual points to the Actual Points field (yes, that is confusing). phw, please add any actual points of yours to those.

Closing. Thanks!

Trac:
Resolution: N/A to fixed
Status: merge_ready to closed
Actualpoints: N/A to 0.1
Cc: acute to acute, metrics-team
Points: 0.3 to 0.2

Adding my 0.1 actual points.

Trac:
Actualpoints: 0.1 to 0.2

Trac:
Parent: N/A to #33321 (moved)

closed

changed time estimate to 1h 36m

added 1h 36m of time spent

mentioned in issue #33321 (moved)