chihsuan opened a new pull request, #10404:
URL: https://github.com/apache/ozone/pull/10404

   ## What changes were proposed in this pull request?
   
   The `ozone` command 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 internal `OZONE_RUN_ARTIFACT_NAME` variable in 
favor of user-facing wording. Applied to both the shell usage menu and the 
autocompletion generator.
   - **`envvars`**: refer to "Ozone" instead of "Hadoop" environment variables.
   - **`--daemon`** (autocompletion source): fix a description accidentally 
copy-pasted from `--buildpaths`; it now reads "operate on a daemon".
   - **`shell` alias**: 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.
   
   Each change is a separate commit. Items from the Jira that were 
intentionally left out: flagging/removing the `csi` daemon (it is an alpha but 
official, documented interface, not obsolete) and surfacing the deprecated 
`auditparser`/`checknative` commands (they are deliberately kept out of the 
menu and already print a deprecation warning).
   
   ## 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 --help` shows all four updated usage lines (`--jvmargs` appended, 
`--validate [continue]`, `envvars` → Ozone, `sh ... (alias: shell)`).
   - `ozone shell --help` routes to `OzoneShell` (the alias is functional).
   - `ozone completion bash` lists both `sh` and `shell` in the top-level 
candidate list and dispatcher.
   - `checkstyle:check` passes on the changed modules (`hadoop-ozone/tools`, 
`hadoop-ozone/cli-shell`).
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to