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

More helpful pdnsutil help output #15082

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

miodvallat
Copy link
Contributor

Short description

This is another take at #12350 ("Group pdnsutil usage by topic"). The dictionary of pdnsutil commands is extended with a "command group" and the short help text, for every command. This allows these help texts to be output in groups, with alphabetical ordering within each group, automagically.

Doing this also exposes a few commands which lack help texts, these can either remain hidden or get gifted a nice help text (to be discussed in this PR).

The grouping of commands is stolen borrowed from #12350 and open for discussion as well. The changes in this PR allow for group assignment to be changed very easily, as well as new groups created, if deemed useful.

Checklist

I have:

  • read the CONTRIBUTING.md document
  • compiled this code
  • tested this code
  • included documentation (including possible behaviour changes)
  • documented the code
  • added or modified regression test(s)
  • added or modified unit test(s)

This extends the commands dictionary with a command group and the
one-liner help message. When the list of these one-liners get output,
they are now output in sorted order within each group.
@coveralls
Copy link

Pull Request Test Coverage Report for Build 12931605740

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 33 unchanged lines in 11 files lost coverage.
  • Overall coverage decreased (-0.004%) to 64.697%

Files with Coverage Reduction New Missed Lines %
modules/gpgsqlbackend/gpgsqlbackend.cc 1 88.62%
pdns/signingpipe.cc 1 85.25%
pdns/dnsdistdist/dnsdist-crypto.cc 1 76.01%
ext/json11/json11.cpp 1 64.49%
pdns/misc.cc 2 62.71%
pdns/remote_logger.cc 3 54.26%
modules/gpgsqlbackend/spgsql.cc 3 68.18%
pdns/recursordist/test-syncres_cc1.cc 5 89.87%
pdns/packethandler.cc 5 72.48%
pdns/recursordist/syncres.cc 5 79.86%
Totals Coverage Status
Change from base Build 12927190209: -0.004%
Covered Lines: 127817
Relevant Lines: 166470

💛 - Coveralls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants