Skip to content

Commit

Permalink
btrfs-progs: docs: fix document references in html build
Browse files Browse the repository at this point in the history
The references used in :doc: need to reference relative path of the
document, otherwise this leads to a warning.

  btrfs-progs/Documentation/Send-receive.rst:19: WARNING: unknown document: 'dev-send-stream' [ref.doc]
  btrfs-progs/Documentation/dev/CmdLineConventions.rst:60: WARNING: unknown document: 'btrfstune' [ref.doc]

Signed-off-by: David Sterba <[email protected]>
  • Loading branch information
kdave committed Feb 14, 2025
1 parent 2f09d42 commit d3c430b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Documentation/Send-receive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ truncate), whole file operations (rename, delete). The stream can be sent over
network, piped directly to the receive command or saved to a file. Each command
in the stream is protected by a CRC32C checksum, with 0 as the initial value
and no inversion. See :doc:`btrfs-send` and :doc:`btrfs-receive` for more,
for protocol description :doc:`dev-send-stream`.
for protocol description :doc:`dev/dev-send-stream`.
2 changes: 1 addition & 1 deletion Documentation/dev/CmdLineConventions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ or change descriptions.

* brief but descriptive
* long and descriptive can be used in justified cases (e.g. conversion options
in :doc:`btrfstune` because of the single command without subcommands)
in :doc:`../btrfstune` because of the single command without subcommands)

Option parameters
^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit d3c430b

Please sign in to comment.