HDDS-15420. Update Ozone command help menu#10404
Open
chihsuan wants to merge 7 commits into
Open
Conversation
Change 'will be append' to 'will be appended' in the --jvmargs option description.
Use [continue] to denote the optional argument and drop the internal OZONE_RUN_ARTIFACT_NAME reference from the user-facing description, in both the shell usage menu and the autocompletion generator.
…urce The --daemon option description was accidentally copied from --buildpaths. Correct it to 'operate on a daemon' for source consistency. (picocli's generated completion emits option names only, so this is not user-visible today.)
The 'shell' alias for 'sh' is accepted by the ozone script but was undocumented and unknown to the autocompletion generator. Note it in the usage menu and register it on the OzoneShell command, so generated bash/zsh completion lists and dispatches 'shell' as well.
…ge text The --validate misuse/error message and its function doc still named the internal OZONE_RUN_ARTIFACT_NAME variable. Reword to user-facing text, consistent with the usage menu and autocompletion descriptions.
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
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.
What changes were proposed in this pull request?
The
ozonecommand help menu (ozone --help) and the generated shell autocompletion contained outdated, incorrect, and confusing entries. This PR cleans them up:--jvmargs: fix typo "will be append" → "will be appended".--validate: change the ambiguous(continue)notation to[continue](square brackets denote the optional argument), and reword the description to drop the leaky internalOZONE_RUN_ARTIFACT_NAMEvariable in favor of user-facing wording. Applied to all three copies: the shell usage menu, the autocompletion generator, and the--validatemisuse/error message inozone-functions.sh.envvars: refer to "Ozone" instead of "Hadoop" environment variables, in both the shell usage menu and the tools docs page.--daemon(autocompletion source): fix a description accidentally copy-pasted from--buildpaths; it now reads "operate on a daemon".shellalias: theshellalias forshis accepted by theozonescript but was undocumented and unknown to the autocompletion generator. Note it in the usage menu and register it on theOzoneShellcommand so generated bash/zsh completion lists and dispatchesshellas well.Each change is a separate commit. A few items mentioned in the Jira are intentionally scoped out of this PR, and I'm happy to revisit if reviewers prefer otherwise:
csi: the Jira suggests it may be legacy. But it seems currently an alpha-but-documented, shipped interface with no in-repo replacement, and deprecating a daemon feels like a separate decision (own Jira + dev-list) rather than a help-text cleanup. Left as-is here.auditparser/checknative: already deprecated and redirected with a warning; since deprecated commands are normally not advertised in the menu, I left them out, but can document them if preferred.What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-15420
How was this patch tested?
Built a distribution (
mvn clean install -DskipTests -Pdist) and verified against the running binary:ozone --helpshows all four updated usage lines (--jvmargsappended,--validate [continue],envvars→ Ozone,sh ... (alias: shell)).Details
ozone shell --helproutes toOzoneShell(the alias is functional).Details
ozone completion bashlists bothshandshellin the top-level candidate list and dispatcher.checkstyle:checkpasses on the changed modules (hadoop-ozone/tools,hadoop-ozone/cli-shell).