]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commit
doc: update mgr module command documentation for per-module registries 67257/head
authorKefu Chai <k.chai@proxmox.com>
Mon, 9 Feb 2026 02:09:14 +0000 (10:09 +0800)
committerKefu Chai <k.chai@proxmox.com>
Sun, 8 Mar 2026 15:27:30 +0000 (23:27 +0800)
commit1832b1572cbd303bae8709264ce46917f331350a
tree252d91c307b86f7ac20f5fceb6f5a477e158ef2f
parent82e791713c4862f9eead667e9df1e90728255bae
doc: update mgr module command documentation for per-module registries

Update documentation to reflect the new per-module command registry
pattern introduced in PR #66467. The old global CLICommand decorators
have been replaced with module-specific registries.

Changes:
- doc/mgr/modules.rst: Rewrite CLICommand section with setup guide,
  update all examples to use AntigravityCLICommand pattern
- src/pybind/mgr/object_format.py: Add note explaining per-module
  registries and update all decorator examples
- doc/dev/developer_guide/dash-devel.rst: Update dashboard plugin
  examples to use DBCLICommand

All examples now correctly show:
- Creating registry with CLICommandBase.make_registry_subtype()
- Using module-specific decorator names (e.g., @StatusCLICommand.Read)
- Setting CLICommand class attribute for framework registration

Signed-off-by: Kefu Chai <k.chai@proxmox.com>
doc/dev/developer_guide/dash-devel.rst
doc/mgr/modules.rst
src/pybind/mgr/object_format.py