docs: move global/fabrics options into separate files#3227
Merged
igaw merged 1 commit intolinux-nvme:masterfrom Apr 1, 2026
Merged
docs: move global/fabrics options into separate files#3227igaw merged 1 commit intolinux-nvme:masterfrom
igaw merged 1 commit intolinux-nvme:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reduces duplication across the nvme-cli manpages by extracting commonly repeated “global” option documentation into a shared include file and updating command docs to reference it.
Changes:
- Introduced a shared
Documentation/global-options.txtinclude for common CLI options. - Updated many command manpages to reference
[<global-options>]in SYNOPSIS andinclude::global-options.txt[]in OPTIONS. - Updated the Documentation Meson build to ensure include files are available during doc generation.
Reviewed changes
Copilot reviewed 299 out of 299 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| Documentation/nvme.txt | Replaces duplicated top-level option docs with global-options.txt include and updates synopsis to show global options. |
| Documentation/nvme-zns-zrwa-flush-zone.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-zone-mgmt-send.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-zone-mgmt-recv.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-zns-zone-append.txt | Adds global-options.txt include and updates synopsis. |
| Documentation/nvme-zns-set-zone-desc.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-reset-zone.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-report-zones.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-zns-open-zone.txt | Replaces duplicated timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-zns-offline-zone.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-id-ns.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-zns-id-ctrl.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-zns-finish-zone.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-close-zone.txt | Replaces duplicated timeout docs with global-options.txt include. |
| Documentation/nvme-zns-changed-zone-list.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-write.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-write-zeroes.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-write-uncor.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-wdc-vs-temperature-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-vs-telemetry-controller-option.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-vs-smart-add-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-vs-nand-stats.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-vs-internal-log.txt | Replaces duplicated verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-vs-hw-rev-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-vs-fw-activate-history.txt | Replaces duplicated output-format docs with global-options.txt include and updates section formatting. |
| Documentation/nvme-wdc-vs-error-reason-identifier.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-vs-drive-info.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-vs-device-waf.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-vs-cloud-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-set-latency-monitor-feature.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-purge.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-purge-monitor.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-namespace-resize.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-log-page-directory.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-id-ctrl.txt | Replaces duplicated output-format docs with global-options.txt include and updates human-readable description. |
| Documentation/nvme-wdc-get-unsupported-reqs-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-get-pfail-dump.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-get-latency-monitor-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-get-error-recovery-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-get-drive-status.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-get-dev-capabilities-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-get-crash-dump.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-enc-get-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-drive-resize.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-drive-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-drive-essentials.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-cu-smart-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-wdc-cloud-SSD-plugin-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-cloud-boot-SSD-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-clear-pcie-correctable-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-clear-fw-activate-history.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-clear-assert-dump.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-capabilities.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-wdc-cap-diag.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-virtium-show-identify.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-virtium-save-smart-to-vtview-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-virt-mgmt.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-verify.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-transcend-healthvalue.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-transcend-badblock.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-toshiba-vs-smart-add-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-toshiba-vs-internal-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-toshiba-clear-pcie-correctable-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-tls-key.txt | Replaces duplicated verbose docs with global-options.txt include. |
| Documentation/nvme-telemetry-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-supported-log-pages.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-supported-cap-config-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-subsystem-reset.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-workload-tracker.txt | Replaces duplicated verbose docs with global-options.txt include and updates synopsis layout. |
| Documentation/nvme-solidigm-vs-smart-add-log.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-vs-internal-log.txt | Replaces duplicated verbose docs with global-options.txt include and updates synopsis layout. |
| Documentation/nvme-solidigm-vs-fw-activate-history.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-vs-drive-info.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-temp-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-solidigm-smart-log-add.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-parse-telemetry-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-solidigm-market-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-solidigm-log-page-directory.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-latency-tracking-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis layout. |
| Documentation/nvme-solidigm-id-ctrl.txt | Reworks OPTIONS section to use global-options.txt include and adjusts human-readable docs. |
| Documentation/nvme-solidigm-garbage-collect-log.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-solidigm-cloud-SSDplugin-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-solidigm-clear-pcie-correctable-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-solidigm-clear-fw-activate-history.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-vs-temperature-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-vs-telemetry-controller-option.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-vs-smart-add-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-vs-pcie-stats.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-vs-nand-stats.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-vs-internal-log.txt | Replaces duplicated verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-vs-hw-rev-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-vs-fw-activate-history.txt | Replaces duplicated output-format + large table block with global-options.txt include. |
| Documentation/nvme-sndk-vs-error-reason-identifier.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-vs-drive-info.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-vs-device-waf.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-vs-cloud-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-set-latency-monitor-feature.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-namespace-resize.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-log-page-directory.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-get-unsupported-reqs-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-get-latency-monitor-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-get-error-recovery-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-get-drive-status.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-get-dev-capabilities-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-drive-resize.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-cu-smart-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-sndk-cloud-SSD-plugin-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-cloud-boot-SSD-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-clear-pcie-correctable-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-clear-fw-activate-history.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-clear-assert-dump.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sndk-capabilities.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-smart-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-show-topology.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-show-regs.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-show-hostnqn.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-set-reg.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-set-property.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-set-feature.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-self-test-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-sed-unlock.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sed-revert.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sed-password.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sed-lock.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sed-initialize.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sed-discover.txt | Replaces duplicated verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-security-send.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-security-recv.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-seagate-vs-temperature-stats.txt | Adds global options to synopsis and replaces output-format docs with global-options.txt include. |
| Documentation/nvme-seagate-vs-smart-add-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-vs-pcie-stats.txt | Adds global options to synopsis and replaces output-format docs with global-options.txt include. |
| Documentation/nvme-seagate-vs-log-page-sup.txt | Adds global options to synopsis and replaces output-format docs with global-options.txt include. |
| Documentation/nvme-seagate-vs-internal-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-vs-fw-activate-history.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-plugin-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-help.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-get-host-tele.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-get-ctrl-tele.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-cloud-SSD-plugin-version.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-clear-pcie-correctable-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-seagate-clear-fw-activate-history.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-sanitize.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-sanitize-log.txt | Replaces duplicated output-format/verbose/human-readable docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-rpmb.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-rotational-media-info-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-resv-report.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-resv-release.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-resv-register.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-resv-notif-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-resv-acquire.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-reset.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-read.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-reachability-groups-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-reachability-associations-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-pull-model-ddr-req-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-primary-ctrl-caps.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-predictable-lat-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-pred-lat-event-agg-log.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-phy-rx-eom-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and removes duplicated option text. |
| Documentation/nvme-persistent-event-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-ocp-unsupported-reqs-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-telemetry-string-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-tcg-configuration-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-smart-add-log.txt | Replaces duplicated output-format + output-format-version docs with global-options.txt include. |
| Documentation/nvme-ocp-set-telemetry-profile.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-set-plp-health-check-interval.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-set-error-injection.txt | Replaces duplicated timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-set-dssd-power-state-feature.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-set-dssd-async-event-config.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-persistent-event-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-ocp-latency-monitor-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-internal-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-hardware-component-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-get-telemetry-profile.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-plp-health-check-interval.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-latency-monitor.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-idle-wakeup-time.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-error-injection.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-dssd-power-state-feature.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-dssd-async-event-config.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-get-clear-pcie-correctable-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-error-recovery-log.txt | Rewrites page to include global options and updates synopsis. |
| Documentation/nvme-ocp-eol-plp-failure-mode.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-device-capability-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-ocp-clear-fw-activate-history.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-nvme-mi-send.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-nvme-mi-recv.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-nvm-id-ns.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-nvm-id-ns-lba-format.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-nvm-id-ctrl.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ns-rescan.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-ns-descs.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-netapp-smdevices.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-netapp-ontapdevices.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-micron-temperature-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-micron-smart-log.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-micron-smart-add-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-micron-selective-download.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-micron-pcie-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-micron-nand-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-micron-internal-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-micron-id-ctrl.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-micron-clear-pcie-errors.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-mi-cmd-support-effects-log.txt | Replaces duplicated human-readable/output-format/verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-mgmt-addr-list-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-media-unit-stat-log.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-mangoboost-id-ctrl.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-lockdown.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-list.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-list-subsys.txt | Replaces duplicated verbose/output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-list-secondary.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-list-ns.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-list-endgrp.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-list-ctrl.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-lba-status-log.txt | Replaces duplicated verbose/output-format docs with global-options.txt include. |
| Documentation/nvme-io-passthru.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-io-mgmt-send.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-io-mgmt-recv.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-intel-temp-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-intel-smart-log-add.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-intel-market-name.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-intel-lat-stats.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-intel-internal-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-intel-id-ctrl.txt | Replaces duplicated output-format/human-readable docs with global-options.txt include. |
| Documentation/nvme-inspur-nvme-vendor-log.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-id-uuid.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-id-nvmset.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-id-ns.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-id-ns-lba-format.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-id-ns-granularity.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-id-iocs.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-id-domain.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-id-ctrl.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and adds/updates human-readable docs. |
| Documentation/nvme-huawei-list.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-huawei-id-ctrl.txt | Replaces duplicated output-format docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-host-discovery-log.txt | Replaces duplicated verbose/output-format/timeout docs with global-options.txt include. |
| Documentation/nvme-help.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-get-reg.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-get-property.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-get-ns-id.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-get-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-get-lba-status.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-get-feature.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-gen-tls-key.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-gen-hostnqn.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-gen-dhchap-key.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-fw-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-fw-download.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-fw-commit.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-format.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-flush.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-fid-support-effects-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-fdp-usage.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-fdp-update.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-fdp-status.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-fdp-stats.txt | Replaces duplicated output-format docs with global-options.txt include. |
| Documentation/nvme-fdp-set-events.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-fdp-feature.txt | Replaces duplicated verbose docs with global-options.txt include and updates synopsis formatting. |
| Documentation/nvme-fdp-events.txt | Replaces duplicated output-format docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-fdp-configs.txt | Replaces duplicated output-format docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-error-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-endurance-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-endurance-event-agg-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-effects-log.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-dsm.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-dispersed-ns-participating-nss-log.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-disconnect-all.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-disconnect.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-dir-send.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-dir-receive.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-dim.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-device-self-test.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-detach-ns.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-dera-stat.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-delete-ns.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-dapustor-smart-log-add.txt | Adds global options to synopsis and includes global-options.txt under OPTIONS. |
| Documentation/nvme-create-ns.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-copy.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-compare.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-cmdset-ind-id-ns.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates human-readable docs. |
| Documentation/nvme-check-tls-key.txt | Replaces duplicated output-format/verbose docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-check-dhchap-key.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-changed-ns-list-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-changed-alloc-ns-list-log.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-capacity-mgmt.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include. |
| Documentation/nvme-boot-part-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-ave-discovery-log.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/nvme-attach-ns.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-ana-log.txt | Replaces duplicated output-format/verbose docs with global-options.txt include. |
| Documentation/nvme-admin-passthru.txt | Replaces duplicated output-format/verbose/timeout docs with global-options.txt include and updates synopsis. |
| Documentation/meson.build | Adds global-options.txt and fabrics-options.txt to the include list copied during doc builds. |
| Documentation/global-options.txt | New shared include defining common CLI options for reuse across manpages. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| -o <fmt>:: | ||
| --output-format=<fmt>:: | ||
| Set the reporting format to 'normal', 'json', or 'binary'. |
There was a problem hiding this comment.
--output-format documentation doesn’t match the CLI: the code advertises tabular as a supported format (and json support depends on build configuration). Update this description to include tabular and clarify when json is available so included manpages don’t misdocument supported formats.
Suggested change
| Set the reporting format to 'normal', 'json', or 'binary'. | |
| Set the reporting format to 'normal', 'tabular', or 'binary'. | |
| The 'json' format is also available when built with JSON support. |
Comment on lines
10
to
14
| [verse] | ||
| 'nvme sanitize-log' <device> [--rae | -r] [--human-readable | -H] | ||
| 'nvme sanitize-log' <device> [--rae | -r] | ||
| [--raw-binary | -b] | ||
| [--output-format=<fmt> | -o <fmt>] [--verbose | -v] | ||
| [<global-options>] | ||
|
|
There was a problem hiding this comment.
This manpage dropped the --human-readable/-H option from the SYNOPSIS/OPTIONS, but the command still supports it (see sanitize_log option parsing in nvme.c using OPT_FLAG("human-readable", 'H', ...)). Please re-add --human-readable | -H to the synopsis and document it under OPTIONS (in addition to the global options include).
Comment on lines
40
to
44
| -H:: | ||
| --human-readable:: | ||
| This option will parse and format many of the bit fields | ||
| into human-readable formats. | ||
| Display values in a human-readable format where possible. | ||
| (deprecated, use --verbose) | ||
|
|
There was a problem hiding this comment.
The manpage now marks --human-readable/-H as deprecated, but the CLI help strings still describe it as an active option (e.g., human_readable_identify = "show identify in readable format" in nvme.c) and it isn’t flagged as deprecated in the parser. Either remove the deprecation note here (and in other affected manpages), or update the CLI/help output to match the deprecation status.
Reduce the huge documentation duplication of the common global and fabrics options by moving them into separate files and include them. Used the magic regex engine called Copilot for modifying all files. Signed-off-by: Daniel Wagner <wagi@kernel.org>
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.
Reduce the huge documentation duplication of the common global and fabrics options by moving them into separate files and include them.