]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
doc/cephfs: Fix Sphinx warnings and other minor improvements 65909/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 13 Oct 2025 07:51:01 +0000 (14:51 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Mon, 13 Oct 2025 08:33:35 +0000 (15:33 +0700)
commit3fa4457ca9c6868d10b38e5df91290fe432a9611
tree730c1da81fdbfce6716d17cf8750ef3a59384378
parentbe913b3b0701b040bd2b98c1778764846a8f62bb
doc/cephfs: Fix Sphinx warnings and other minor improvements

Fix 2 Sphinx warnings about problematic syntax in troubleshooting.rst:
add empty lines between paragraphs.

In fs-volumes.rst:

Fix 1 Sphinx warning about problematic syntax:
Fix indentation and change to ordered list instead of manually
hardcoding item numbers.

Use privileged bash prompt consistently for privileged commands.

Use the "[...] run a command of the following form:" for CLI examples
with placeholders.

Fix accidental emphasis on a list item by adding empty lines around
sub-list.

Use title case in section titles and trim overly long underline.

Capitalize UID, GID, Unicode, Ceph in text.

Use double backticks consistently for command line switches, data, etc.

Start with capital case and end in full stop if full sentence.

Linkify mention of quiesce dev doc and add a label for it in
doc/dev/mds_internals/quiesce.rst.

Other very minor changes like typo, remove space at end of line.

Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com>
doc/cephfs/fs-volumes.rst
doc/cephfs/troubleshooting.rst
doc/dev/mds_internals/quiesce.rst