]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: fix most invalid directives missing a second colon 66814/head
authorVille Ojamo <14869000+bluikko@users.noreply.github.com>
Tue, 6 Jan 2026 14:59:34 +0000 (21:59 +0700)
committerVille Ojamo <14869000+bluikko@users.noreply.github.com>
Tue, 6 Jan 2026 15:23:57 +0000 (22:23 +0700)
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>
12 files changed:
doc/architecture.rst
doc/cephfs/snap-schedule.rst
doc/dev/development-workflow.rst
doc/mgr/mds_autoscaler.rst
doc/rados/operations/crush-map.rst
doc/rados/operations/placement-groups.rst
doc/rados/troubleshooting/troubleshooting-pg.rst
doc/radosgw/vault.rst
doc/releases/dumpling.rst
doc/releases/kraken.rst
doc/releases/pacific.rst
doc/releases/squid.rst

index 25beebf037e42312e5386b59627bd006bf10e91c..c16aa3db1e7ae88d545e77b08cd71c3dfc025dec 100644 (file)
@@ -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
 ~~~~~~~~~~~~~~~~~~~
index 48e790478642f383149bfdaf328d568b2f45808f..2059d56fec5a5e0af6a792f60a3468df4b45786e 100644 (file)
@@ -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
 -----------------------------
index 530944bf580ddb46cbde4fa3eacffb53d1a0a0e6..8065a69b0450e6b5e39a1829296fd8ca05512334 100644 (file)
@@ -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.
 
index 884e16c0055a340b7467345366c3891f4915165c..4fbbc558a151aff5c0e3ae9bcd85fdcc47e44f53 100644 (file)
@@ -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.
index d382f71c4a186e63f9a3ca5f3e00ac8aa6a6acca..1f74de5124129b86a3bfe2c8031b1fe9dc0ba9d8 100644 (file)
@@ -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.
 
index 2a3ce0115367994f36972e682f5f933b86f8a67c..c7a62beb1e12a584cbd9d77ae379b0c650980fda 100644 (file)
@@ -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`.
index 161be53d58628010de3f9981f8ee97dad7b72bfe..f1355b02c735f751841223cb720bf22504c4cf95 100644 (file)
@@ -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
index fec7b265b50ca13e4aa3bc17d9395e9627c69487..9db28272c1cb4af56cf6769792bf4fd945282748 100644 (file)
@@ -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
index b9946546ea736c29c6ab0d76e53bb4638ae7798f..643674c2e70f747e214c2a841428d2f5379d52d6 100644 (file)
@@ -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
index 3d39e3293b3d314b4e0a1cd25b8b975d65b7512d..5f501b2c61fc3f3a3905d341e72d74dd6eea1933 100644 (file)
@@ -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
index 36e6483fae6fe05c0d3fe9574ad3301aa8727f0c..f9d6d485096841d6dd8912ac4fd72d972df96fc5 100644 (file)
@@ -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 <realm>.<zone> --port 7280
 
index e54faccbc8011c02c2a2146c544648eaaac5413f..54539579d2906603269a067461b75a023b63acc0 100644 (file)
@@ -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
 ------------