From 26676cf8d51dd5cffdeeb502afad3faabc94302c Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Tue, 6 Jan 2026 21:59:34 +0700 Subject: [PATCH] doc: fix most invalid directives missing a second colon Add the second colon to RST markup that was missing it. Some very important admonitions were not rendered at all because of the syntax error. "Most" because the two remaining occurrences are fixed elsewhere. Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> --- doc/architecture.rst | 2 +- doc/cephfs/snap-schedule.rst | 8 ++++---- doc/dev/development-workflow.rst | 2 +- doc/mgr/mds_autoscaler.rst | 2 +- doc/rados/operations/crush-map.rst | 2 +- doc/rados/operations/placement-groups.rst | 2 +- doc/rados/troubleshooting/troubleshooting-pg.rst | 2 +- doc/radosgw/vault.rst | 2 +- doc/releases/dumpling.rst | 2 +- doc/releases/kraken.rst | 2 +- doc/releases/pacific.rst | 4 ++-- doc/releases/squid.rst | 4 ++-- 12 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/architecture.rst b/doc/architecture.rst index 25beebf037e..c16aa3db1e7 100644 --- a/doc/architecture.rst +++ b/doc/architecture.rst @@ -528,7 +528,7 @@ Pools set at least the following parameters: See :ref:`setpoolvalues` for details. -.. index: architecture; placement group mapping +.. index:: architecture; placement group mapping Mapping PGs to OSDs ~~~~~~~~~~~~~~~~~~~ diff --git a/doc/cephfs/snap-schedule.rst b/doc/cephfs/snap-schedule.rst index 48e79047864..2059d56fec5 100644 --- a/doc/cephfs/snap-schedule.rst +++ b/doc/cephfs/snap-schedule.rst @@ -149,25 +149,25 @@ Examples:: ceph fs snap-schedule retention add / 24h4w # add 24 hourly and 4 weekly to retention ceph fs snap-schedule retention remove / 7d4w # remove 7 daily and 4 weekly, leaves 24 hourly -.. note: When adding a path to snap-schedule, remember to strip off the mount +.. note:: When adding a path to snap-schedule, remember to strip off the mount point path prefix. Paths to snap-schedule should start at the appropriate CephFS file system root and not at the host file system root. e.g. if the Ceph File System is mounted at ``/mnt`` and the path under which snapshots need to be taken is ``/mnt/some/path`` then the acutal path required by snap-schedule is only ``/some/path``. -.. note: It should be noted that the "created" field in the snap-schedule status +.. note:: It should be noted that the "created" field in the snap-schedule status command output is the timestamp at which the schedule was created. The "created" timestamp has nothing to do with the creation of actual snapshots. The actual snapshot creation is accounted for in the "created_count" field, which is a cumulative count of the total number of snapshots created so far. -.. note: The maximum number of snapshots to retain per directory is limited by the +.. note:: The maximum number of snapshots to retain per directory is limited by the config tunable `mds_max_snaps_per_dir`. This tunable defaults to 100. To ensure a new snapshot can be created, one snapshot less than this will be retained. So by default, a maximum of 99 snapshots will be retained. -.. note: The --fs argument is now required if there is more than one file system. +.. note:: The --fs argument is now required if there is more than one file system. Active and inactive schedules ----------------------------- diff --git a/doc/dev/development-workflow.rst b/doc/dev/development-workflow.rst index 530944bf580..8065a69b045 100644 --- a/doc/dev/development-workflow.rst +++ b/doc/dev/development-workflow.rst @@ -243,7 +243,7 @@ differences: * All commits are cherry-picked with ``git cherry-pick -x`` to reference the original commit -.. note: If a backport is appropriate, the submitter is responsible for +.. note:: If a backport is appropriate, the submitter is responsible for determining appropriate target stable branches to which backports must be made. diff --git a/doc/mgr/mds_autoscaler.rst b/doc/mgr/mds_autoscaler.rst index 884e16c0055..4fbbc558a15 100644 --- a/doc/mgr/mds_autoscaler.rst +++ b/doc/mgr/mds_autoscaler.rst @@ -19,6 +19,6 @@ The Ceph monitor daemons remain responsible for promoting or stopping MDS according to these settings. The ``mds_autoscaler`` simply adjusts the number of MDS daemons spawned by the orchestrator. -.. note: There is no CLI as of the Tentacle release. There are no module +.. note:: There is no CLI as of the Tentacle release. There are no module configurations as of the Tentacle release. Enable or disable the module to turn the functionality on or off. diff --git a/doc/rados/operations/crush-map.rst b/doc/rados/operations/crush-map.rst index d382f71c4a1..1f74de51241 100644 --- a/doc/rados/operations/crush-map.rst +++ b/doc/rados/operations/crush-map.rst @@ -747,7 +747,7 @@ The relevant erasure-code profile properties are as follows: ceph osd crush rule create-erasure {name} {profile-name} -.. note: When creating a new pool, it is not necessary to create the rule +.. note:: When creating a new pool, it is not necessary to create the rule explicitly. If only the erasure-code profile is specified and the rule argument is omitted, then Ceph will create the CRUSH rule automatically. diff --git a/doc/rados/operations/placement-groups.rst b/doc/rados/operations/placement-groups.rst index 2a3ce011536..c7a62beb1e1 100644 --- a/doc/rados/operations/placement-groups.rst +++ b/doc/rados/operations/placement-groups.rst @@ -631,7 +631,7 @@ For this reason, limiting the number of PGs saves significant resources. Choosing the Number of PGs ========================== -.. note: It is rarely necessary to do the math in this section by hand. +.. note:: It is rarely necessary to do the math in this section by hand. Instead, use the ``ceph osd pool autoscale-status`` command in combination with the ``target_size_bytes`` or ``target_size_ratio`` pool properties. For more information, see :ref:`pg-autoscaler`. diff --git a/doc/rados/troubleshooting/troubleshooting-pg.rst b/doc/rados/troubleshooting/troubleshooting-pg.rst index 161be53d586..f1355b02c73 100644 --- a/doc/rados/troubleshooting/troubleshooting-pg.rst +++ b/doc/rados/troubleshooting/troubleshooting-pg.rst @@ -551,7 +551,7 @@ For example: ceph pg repair 1.4 -.. warning: This command overwrites the "bad" copies with "authoritative" +.. warning:: This command overwrites the "bad" copies with "authoritative" copies. In most cases, Ceph is able to choose authoritative copies from all the available replicas by using some predefined criteria. This, however, does not work in every case. For example, it might be the case that the diff --git a/doc/radosgw/vault.rst b/doc/radosgw/vault.rst index fec7b265b50..9db28272c1c 100644 --- a/doc/radosgw/vault.rst +++ b/doc/radosgw/vault.rst @@ -167,7 +167,7 @@ only Ceph itself should be doing that. Token Authentication -------------------- -.. note: Never use root tokens with Ceph in production environments. +.. note:: Never use root tokens with Ceph in production environments. The token authentication method expects a Vault token to be present in a plaintext file. The Object Gateway can be configured to use token authentication diff --git a/doc/releases/dumpling.rst b/doc/releases/dumpling.rst index b9946546ea7..643674c2e70 100644 --- a/doc/releases/dumpling.rst +++ b/doc/releases/dumpling.rst @@ -237,7 +237,7 @@ For more detailed information, see :download:`the complete changelog <../changel v0.67.6 "Dumpling" ================== -.. note: This release contains a librbd bug that is fixed in v0.67.7. Please upgrade to v0.67.7 and do not use v0.67.6. +.. note:: This release contains a librbd bug that is fixed in v0.67.7. Please upgrade to v0.67.7 and do not use v0.67.6. This Dumpling point release contains a number of important fixed for the OSD, monitor, and radosgw. Most significantly, a change that diff --git a/doc/releases/kraken.rst b/doc/releases/kraken.rst index 3d39e3293b3..5f501b2c61f 100644 --- a/doc/releases/kraken.rst +++ b/doc/releases/kraken.rst @@ -421,7 +421,7 @@ of BlueStore include: The BlueStore on-disk format is expected to continue to evolve. However, we will provide support in the OSD to migrate to the new format on upgrade. -.. note: BlueStore is still marked "experimental" in Kraken. We +.. note:: BlueStore is still marked "experimental" in Kraken. We recommend its use for proof-of-concept and test environments, or other cases where data loss can be tolerated. Although it is stable in our testing environment, the code is new and bugs are diff --git a/doc/releases/pacific.rst b/doc/releases/pacific.rst index 36e6483fae6..f9d6d485096 100644 --- a/doc/releases/pacific.rst +++ b/doc/releases/pacific.rst @@ -2724,13 +2724,13 @@ or canceled with Note that canceling the upgrade simply stops the process; there is no ability to downgrade back to Octopus. -.. note: +.. note:: If you have deployed an RGW service on Octopus using the default port (7280), you will need to redeploy it because the default port changed (to 80 or 443, depending on whether SSL is enabled): - .. prompt: bash # + .. prompt:: bash # ceph orch apply rgw . --port 7280 diff --git a/doc/releases/squid.rst b/doc/releases/squid.rst index e54faccbc80..54539579d29 100644 --- a/doc/releases/squid.rst +++ b/doc/releases/squid.rst @@ -508,7 +508,7 @@ v19.2.2 Squid This is the second hotfix release in the Squid series. We recommend that all users update to this release. -.. warning: Upgrade to Squid v19.2.2. Do not upgrade to Squid v19.2.1. +.. warning:: Upgrade to Squid v19.2.2. Do not upgrade to Squid v19.2.1. Release Date ------------ @@ -534,7 +534,7 @@ v19.2.1 Squid ============= This is the first backport release in the Squid series. -.. warning: Do not upgrade to Squid v19.2.1. Upgrade instead to Squid v19.2.2. +.. warning:: Do not upgrade to Squid v19.2.1. Upgrade instead to Squid v19.2.2. Release Date ------------ -- 2.47.3