Update documentation in zonemaster-cli script#336
Merged
tgreenx merged 1 commit intozonemaster:developfrom May 31, 2023
Merged
Conversation
Add missing options Add defaults for each option, when applicable Rephrasing, sanitizing
tgreenx
added
A-Documentation
tgreenx
requested review from
a user,
hannaeko,
marc-vanderwal,
matsduf and
mattias-p
marc-vanderwal
approved these changes
May 31, 2023
Contributor
marc-vanderwal
left a comment
marc-vanderwal
left a comment
There was a problem hiding this comment.
Looks good to me.
ghost
approved these changes
May 31, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This PR proposes an update to the
script/zonemaster-clifile, in particular to be more in line with options (and their documentation) inlib/Zonemaster/CLI.pm.Note that the content in
script/zonemaster-clideliberately provides slightly more detailed documentation than the one inlib/Zonemaster/CLI.pm. This stems from issue #68 (not addressed in this PR), where documentation is done in two different places.Context
Part of v2023.1 release testing
Also see #68
Changes
script/zonemaster-clinstimes,dump_profile,sourceaddr4,sourceaddr6,elapsedHow to test this PR
Check that
perldoc script/zonemaster-cli(orman zonemaster-cli) andzonemaster-cli -hprovide similar, accurate information (although not an exact copy).