Skip to content

docs: clarify hotplug-hook subcommands in CLI reference - #7005

Open
kaivshah wants to merge 1 commit into
canonical:mainfrom
kaivshah:fix-hotplug-cli-docs
Open

docs: clarify hotplug-hook subcommands in CLI reference#7005
kaivshah wants to merge 1 commit into
canonical:mainfrom
kaivshah:fix-hotplug-cli-docs

Conversation

@kaivshah

Copy link
Copy Markdown

The CLI reference lists query, handle, and enable as top-level cloud-init subcommands, but they're actually subcommands of devel hotplug-hook (see cloudinit/cmd/devel/hotplug_hook.py), each requiring --subsystem. This also caused the doc's query heading to collide with the real top-level query command later on the same page. This PR nests them correctly under devel hotplug-hook with accurate example invocations.

Proposed Commit Message

<type>(optional scope): <summary>  # no more than 72 characters

A description of what the change being made is and why it is being
made if the summary line is insufficient.  This should be wrapped at
72 characters.

If you need to write multiple paragraphs, feel free.

Fixes GH-NNNNN (GitHub Issue number. Remove line if irrelevant)
LP: #NNNNNN (Launchpad bug number. Remove line if irrelevant)

Additional Context

Test Steps

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

The CLI reference lists query, handle, and enable as top-level cloud-init subcommands, but they're actually subcommands of devel hotplug-hook (see cloudinit/cmd/devel/hotplug_hook.py), each requiring --subsystem. This also caused the doc's query heading to collide with the real top-level query command later on the same page. This PR nests them correctly under devel hotplug-hook with accurate example invocations.
@github-actions github-actions Bot added the documentation This Pull Request changes documentation label Aug 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This Pull Request changes documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant