docs(cli): add the boot-interface command reference pages#3410
Conversation
Summary by CodeRabbit
WalkthroughAdds documentation for the ChangesBoot Interface CLI Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
@coderabbitai full_review, thanks! |
|
(=^･ω･^=) ✅ Action performedFull review finished. |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3410.docs.buildwithfern.com/infra-controller |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md`:
- Around line 23-25: Correct the repeated measured-boot description in the CLI
help source or documentation template from “This used by measured boot” to “This
is used by measured boot,” then rerun generate-cli-docs so all generated pages
receive the grammar fix.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 1d66eb5c-6068-4c0d-b06d-78708cec3759
📒 Files selected for processing (5)
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-set.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-show.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.mddocs/manuals/nico-admin-cli/hardware.md
| This used by measured boot, where basic output contains just what you | ||
| probably care about, and "extended" output also dumps out all the | ||
| internal UUIDs that are used to associate instances. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the generated grammar before publishing.
Change “This used by measured boot” to “This is used by measured boot.” Since the text is repeated across the generated pages, fix the CLI help source/template and rerun generate-cli-docs rather than patching only one output file.
As per path instructions, Markdown documentation must be reviewed for spelling and grammar.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md` around
lines 23 - 25, Correct the repeated measured-boot description in the CLI help
source or documentation template from “This used by measured boot” to “This is
used by measured boot,” then rerun generate-cli-docs so all generated pages
receive the grammar fix.
Source: Path instructions
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.md`:
- Around line 12-13: Update the nico-admin-cli boot-interface candidates
synopsis to show the required <SORT_BY> argument alongside --sort-by, matching
the option definition below; regenerate the documentation page without changing
other command options.
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md`:
- Around line 11-12: Update the boot-interface synopsis generator or help-source
definition so the --sort-by option is rendered with its required <SORT_BY>
value, then regenerate all boot-interface command pages to apply the corrected
synopsis consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 3e099846-d5ea-45f1-b845-d5b0223ce97a
📒 Files selected for processing (5)
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-set.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-show.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.mddocs/manuals/nico-admin-cli/hardware.md
| **nico-admin-cli boot-interface candidates** \[**--extended**\] | ||
| \[**--sort-by**\] \[**-h**\|**--help**\] \<*MACHINE*\> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
file='docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.md'
printf '\n== File (numbered excerpt) ==\n'
cat -n "$file" | sed -n '1,120p'
printf '\n== Related boot-interface docs (filenames) ==\n'
fd -a 'boot-interface*.md' docs/manuals/nico-admin-cli/commands -t f
printf '\n== Similar synopsis patterns in sibling docs ==\n'
for f in docs/manuals/nico-admin-cli/commands/boot-interface/*.md; do
printf '\n-- %s --\n' "$f"
sed -n '1,40p' "$f"
doneRepository: NVIDIA/infra-controller
Length of output: 7774
Include <SORT_BY> in the synopsis. The usage line currently shows [--sort-by], but the option is defined as --sort-by <SORT_BY> below. Regenerate the page so the synopsis matches the accepted invocation.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.md`
around lines 12 - 13, Update the nico-admin-cli boot-interface candidates
synopsis to show the required <SORT_BY> argument alongside --sort-by, matching
the option definition below; regenerate the documentation page without changing
other command options.
Source: Path instructions
| **nico-admin-cli boot-interface** \[**--extended**\] \[**--sort-by**\] | ||
| \[**-h**\|**--help**\] \<*subcommands*\> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the target markdown and nearby generated command docs.
printf '\n## Target file\n'
cat -n docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md | sed -n '1,120p'
printf '\n## Related command docs\n'
for f in \
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md \
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-extended.md \
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-sort-by.md \
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-help.md
do
[ -f "$f" ] || continue
printf '\n### %s\n' "$f"
grep -nE 'sort-by|extended|Synopsis|Usage|`--sort-by`|<SORT_BY>' "$f" || true
done
printf '\n## Search for help source definitions\n'
rg -n --hidden --glob '!target' --glob '!**/node_modules/**' 'boot-interface|sort-by|SORT_BY|extended' \
docs crates .github book . 2>/dev/null | sed -n '1,220p'Repository: NVIDIA/infra-controller
Length of output: 30997
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Focus on the exact file and nearby command docs.
cat -n docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md | sed -n '1,120p'
printf '\n---\n'
find docs/manuals/nico-admin-cli/commands/boot-interface -maxdepth 1 -type f | sort | xargs -r -I{} sh -c 'printf "\n### %s\n" "{}"; grep -nE "sort-by|extended|<SORT_BY>|Synopsis|Usage|--help" "{}" || true'Repository: NVIDIA/infra-controller
Length of output: 3275
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Show the exact markdown section around the synopsis and option table.
sed -n '1,80p' docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.mdRepository: NVIDIA/infra-controller
Length of output: 1495
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the target markdown and discover related generated pages in the same directory.
find docs/manuals/nico-admin-cli/commands/boot-interface -maxdepth 1 -type f | sort
printf '\n--- target ---\n'
sed -n '1,120p' docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.mdRepository: NVIDIA/infra-controller
Length of output: 1811
Show --sort-by <SORT_BY> in the synopsis. docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md:11-12 omits the required value even though the option accepts one. The same synopsis pattern appears on the other boot-interface pages, so fix the generator/help source and regenerate the set.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md` around
lines 11 - 12, Update the boot-interface synopsis generator or help-source
definition so the --sort-by option is rendered with its required <SORT_BY>
value, then regenerate all boot-interface command pages to apply the corrected
synopsis consistently.
Source: Path instructions
Adds the generated `docs/manuals/nico-admin-cli` pages for the new `boot-interface` command family -- `show`, `candidates`, and `set` -- plus its row in the hardware index. The pages start from `generate-cli-docs` output for the commands NVIDIA#3341 adds, with a light copy-edit on the `candidates` and `set` descriptions to drop em-dash-style `--` per the docs style guide; they ride separately so the code PR does not gate on a docs review. This supports NVIDIA#3335 Signed-off-by: Chet Nichols III <chetn@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-set.md`:
- Around line 12-14: Update the boot-interface set synopsis so the --sort-by
option includes its required <SORT_BY> argument, matching the options section;
apply the same correction to the other repeated synopsis occurrence.
- Around line 34-36: Correct the sentence in the boot-interface documentation to
read “This is used by measured boot,” preserving the surrounding explanation of
basic and extended output.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: ec290bf7-f5d9-4b36-8fbc-03290dfd7fa7
📒 Files selected for processing (5)
docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-set.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-show.mddocs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.mddocs/manuals/nico-admin-cli/hardware.md
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface.md
- docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-candidates.md
- docs/manuals/nico-admin-cli/hardware.md
- docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-show.md
| **nico-admin-cli boot-interface set** \[**--reboot**\] | ||
| \[**--extended**\] \[**--sort-by**\] \[**-h**\|**--help**\] | ||
| \<*MACHINE*\> \<*INTERFACE*\> |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Show the required --sort-by value in the synopsis.
The options section documents --sort-by <SORT_BY> as requiring an argument, but the synopsis renders only --sort-by. This makes the generated usage misleading and suggests an invocation that will fail.
Proposed fix
- [**--extended**] [**--sort-by**] [**-h**|**--help**]
+ [**--extended**] [**--sort-by** *<SORT_BY>*] [**-h**|**--help**]Also applies to: 38-39
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-set.md`
around lines 12 - 14, Update the boot-interface set synopsis so the --sort-by
option includes its required <SORT_BY> argument, matching the options section;
apply the same correction to the other repeated synopsis occurrence.
Source: Path instructions
| This used by measured boot, where basic output contains just what you | ||
| probably care about, and "extended" output also dumps out all the | ||
| internal UUIDs that are used to associate instances. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the sentence describing extended output.
“This used by measured boot” is missing “is”; change it to “This is used by measured boot.”
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/manuals/nico-admin-cli/commands/boot-interface/boot-interface-set.md`
around lines 34 - 36, Correct the sentence in the boot-interface documentation
to read “This is used by measured boot,” preserving the surrounding explanation
of basic and extended output.
Source: Path instructions
3 participants
The generated CLI reference pages for the new
boot-interfacecommand family (show,candidates,set) from #3341, plus the hardware-index row -- split out so the code lands independently of the docs review. Straightgenerate-cli-docsoutput, no hand-authored content.This supports #3335