Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

High-level documentation of configuration in Tor. #1546

Merged
merged 1 commit into from Nov 21, 2019
Merged

High-level documentation of configuration in Tor. #1546

merged 1 commit into from Nov 21, 2019

Conversation

Reviewers

@teor2345 teor2345

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
4 participants
@nmathewson @coveralls @teor2345 @torproject-pusher
@nmathewson
Copy link
Contributor

@nmathewson nmathewson commented Nov 15, 2019

Closes ticket 32209.
@nmathewson
High-level documentation of configuration in Tor.
0e4e96b 
Closes ticket 32209.
@coveralls
Copy link

@coveralls coveralls commented Nov 15, 2019

Pull Request Test Coverage Report for Build 7257

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 62.426%
Totals Coverage Status
Change from base Build 7256: 0.0%
Covered Lines: 48723
Relevant Lines: 78049
💛 - Coveralls

teor2345
teor2345 reviewed Nov 20, 2019
View changes
src/lib/conf/config.md
If you're writing configuration code, you'll need a function that
receives the configuration object, and acts upon it. This function
needs to be safe to call multiple times, since Tor will reconfigure
its subsystems whenever it, or whenever it restarts in process.
Copy link
Contributor

@teor2345 teor2345 Nov 20, 2019

Suggested change
its subsystems whenever it, or whenever it restarts in process.
its subsystems whenever it re-reads the torrc, gets a config change from the controller, or restarts in process.

teor2345
teor2345 reviewed Nov 20, 2019
View changes
src/lib/conf/config.md

## Legacy configuration and state

As of this writing, most of the configuration and state is still
Copy link
Contributor

@teor2345 teor2345 Nov 20, 2019

Suggested change
As of this writing, most of the configuration and state is still
As of November 2019, most of the configuration and state is still

teor2345
teor2345 reviewed Nov 20, 2019
View changes
src/lib/conf/config.md

Note that the top level code does not have easy access to the
configuration objects used by the sub-modules. This is by design.
A module _may_ expose its configuration or state object, if it
Copy link
Contributor

@teor2345 teor2345 Nov 20, 2019

Or expose parts of it via accessor functions?

@torproject-pusher torproject-pusher merged commit 0e4e96b into torproject:master Nov 21, 2019
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment