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.

Sign up for GitHub

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

Organize --help text #389

Merged
merged 7 commits into from
Nov 14, 2024
Merged

Organize --help text #389

merged 7 commits into from
Nov 14, 2024

Commits on Nov 14, 2024

  1. Group options in categories

    @mattias-p
    mattias-p committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    2a04ad3 View commit details
    Browse the repository at this point in the history

  2. Update option headings 

    * Add formatting
* Make option arguments more consistent
* Group twin options into the same entry
* Demote option aliases to an option group at the end
    @mattias-p
    mattias-p committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    fb0fb0e View commit details
    Browse the repository at this point in the history

  3. Limit --help to basic options 

    * Hide advanced options from --help output.
* Remove examples from SYNOPSIS section, placing them in an EXAMPLES
  section instead.
* Add proper entries to the SYNOPSIS section.
    @mattias-p
    mattias-p committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    957a6ec View commit details
    Browse the repository at this point in the history

  4. Combine documentation of twin options

    @mattias-p
    mattias-p committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    4bfbd1f View commit details
    Browse the repository at this point in the history

  5. Update defaults declarations 

     * Add missing declarations
 * Change nomenclature from on/off to enabled/disabled
 * Update formatting
    @mattias-p
    mattias-p committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    01a47bf View commit details
    Browse the repository at this point in the history

  6. Update script/zonemaster-cli 

    Co-authored-by: tgreenx <96772376+tgreenx@users.noreply.github.com>
    @mattias-p @tgreenx
    mattias-p and tgreenx committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    447c190 View commit details
    Browse the repository at this point in the history

  7. Point to development documentation from README

    @mattias-p
    mattias-p committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    cdec433 View commit details
    Browse the repository at this point in the history