Skip to content

docs: remove duplicate global/fabrics options from all nvme-*.txt files#19

Closed
igaw with Copilot wants to merge 4 commits into
docsfrom
copilot/remove-duplicate-documentation
Closed

docs: remove duplicate global/fabrics options from all nvme-*.txt files#19
igaw with Copilot wants to merge 4 commits into
docsfrom
copilot/remove-duplicate-documentation

Conversation

Copilot AI commented Apr 1, 2026

Copy link
Copy Markdown

~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.txt and fabrics-options.txt as canonical option references and converted two files as examples. This PR completes the work for all remaining files using a systematic transformation:

  • All nvme-*.txt files: Remove inline global option blocks; replace with include::global-options.txt[]
  • nvme-discover.txt, nvme-connect-all.txt, nvme-config.txt: Also remove inline fabrics option blocks; add include::fabrics-options.txt[]
  • SYNOPSIS sections: Replace per-option listings with [<global-options>] / [<fabrics-options>] placeholders

Example transformation

Before (nvme-ana-log.txt):

OPTIONS
-------
-g::
--groups::
	Return the list of ANA groups without the namespace listing.

-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json' or 'binary'. Only one
	output format can be used at a time.

-v::
--verbose::
	Increase the information detail in the output.

After:

OPTIONS
-------
-g::
--groups::
	Return the list of ANA groups without the namespace listing.

include::global-options.txt[]

Notes

  • Command-specific --dry-run usages (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)
  • Net result: 294 files changed, ~1380 net lines removed

igaw and others added 2 commits April 1, 2026 09:20
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>
Copilot AI and others added 2 commits April 1, 2026 10:08
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
Copilot finished work on behalf of igaw April 1, 2026 10:12
@igaw igaw force-pushed the docs branch 4 times, most recently from 87b4643 to 96b3d86 Compare April 1, 2026 11:10
@igaw igaw closed this Apr 2, 2026
@igaw igaw deleted the copilot/remove-duplicate-documentation branch April 2, 2026 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants