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

Ticket31627 (missing config documentation) #1294

Merged
merged 7 commits into from Sep 5, 2019
Merged

Ticket31627 (missing config documentation) #1294

merged 7 commits into from Sep 5, 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 Sep 4, 2019

No description provided.

nmathewson added 6 commits Sep 4, 2019
@nmathewson
Document configuration and abbreviation types.
577ea20
@nmathewson
config_assign: Document CAL_* options.
aeda598 
These were sort of described in config_assign() documentation, but
not so well.
@nmathewson
Document validate_fn_t as it stands.
39dd2e2 
Also document that it will be changed in a later branch.
@nmathewson
Document return value of config_mgr_add_format().
39316da
@nmathewson
Document warn_deprecated_option().
3db56ae
@nmathewson
Document fields of struct_magic_decl_t.
b3c2867
@coveralls
Copy link

@coveralls coveralls commented Sep 4, 2019 •
edited

Pull Request Test Coverage Report for Build 6074

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.001%) to 63.054%
Files with Coverage Reduction New Missed Lines %
src/feature/hs/hs_common.c 1 85.28%
Totals Coverage Status
Change from base Build 6051: -0.001%
Covered Lines: 47619
Relevant Lines: 75521
💛 - Coveralls

teor2345
teor2345 reviewed Sep 5, 2019
View changes
src/app/config/confparse.c
/**
* Log a warning that declaring that the option called <b>what</b>
* is deprecated because of the reason in <b>why</b>.
**/
void
warn_deprecated_option(const char *what, const char *why)
Copy link
Contributor

@teor2345 teor2345 Sep 5, 2019

This function will fail in log_warn() if what or why are NULL.

We should document that requirement and maybe add BUG() logs.
Or we could pass "" to log_warn() if what or why are NULL.

@nmathewson
config: note that some arguments are required.
eb909c4
@torproject-pusher torproject-pusher merged commit eb909c4 into torproject:master Sep 5, 2019
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment