Closed
docs: remove duplicate global/fabrics options from all nvme-*.txt files#19
Conversation
Reduce the huge documentation duplication of the common global and fabrics options by moving them into separate files and include them. Signed-off-by: Daniel Wagner <wagi@kernel.org>
Replace inline global and fabrics option blocks in all nvme-*.txt documentation files with include::global-options.txt[] and include::fabrics-options.txt[] directives, following the pattern established in the initial commit for nvme-connect.txt and nvme.txt. - Remove -o/--output-format, -v/--verbose, --timeout, -H/--human-readable, --no-retries, --no-ioctl-probing, --output-format-version option blocks from all 294 individual command documentation files - Remove all inline fabrics option blocks from nvme-discover.txt, nvme-connect-all.txt, and nvme-config.txt - Update SYNOPSIS sections to use [<global-options>] and [<fabrics-options>] placeholders instead of listing each option individually - Command-specific uses of --dry-run (with -d, -w short forms) are preserved Agent-Logs-Url: https://github.com/igaw/nvme-cli/sessions/a89608c0-3223-4834-93d5-7154c7c7b96a Co-authored-by: igaw <1050803+igaw@users.noreply.github.com>
Fix leading-space indentation issues introduced when global option references were removed from SYNOPSIS lines that contained multiple option groups on a single line. Convert space-based indentation to tabs in nvme-fdp-feature.txt where the original used space indentation. Agent-Logs-Url: https://github.com/igaw/nvme-cli/sessions/a89608c0-3223-4834-93d5-7154c7c7b96a Co-authored-by: igaw <1050803+igaw@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Refactor documentation to remove duplication in global and fabrics options
docs: remove duplicate global/fabrics options from all nvme-*.txt files
Apr 1, 2026
87b4643 to
96b3d86
Compare
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.
~296 command documentation files each duplicated the full global options block (
--output-format,--verbose,--timeout,--human-readable, etc.) and the three fabrics commands additionally duplicated all fabric transport options inline.Approach
The initial commit established
global-options.txtandfabrics-options.txtas canonical option references and converted two files as examples. This PR completes the work for all remaining files using a systematic transformation:nvme-*.txtfiles: Remove inline global option blocks; replace withinclude::global-options.txt[]nvme-discover.txt,nvme-connect-all.txt,nvme-config.txt: Also remove inline fabrics option blocks; addinclude::fabrics-options.txt[][<global-options>]/[<fabrics-options>]placeholdersExample transformation
Before (
nvme-ana-log.txt):After:
Notes
--dry-runusages (short forms-d,-w) are preserved — they differ semantically from the global--dry-run-v::/--vendor-specific::aliases in vendor files are preserved (not confused with--verbose)