From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Wed, 1 Apr 2026 07:57:18 +0000 (+0700) Subject: doc/man: fix spelling etc errors (1 of 2) X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=ab9dd10241511a862b174004b71faf2fdd58c0f6;p=ceph.git doc/man: fix spelling etc errors (1 of 2) Low-hanging spelling, punctuation, and capitalization errors etc. Ignore style and other more complex issues. Use https for links. Fix markup rendered as-is and indentation in 2 files. Signed-off-by: Ville Ojamo --- diff --git a/doc/man/8/ceph-authtool.rst b/doc/man/8/ceph-authtool.rst index 4e37f01a334e..4a670d64be7a 100644 --- a/doc/man/8/ceph-authtool.rst +++ b/doc/man/8/ceph-authtool.rst @@ -32,7 +32,7 @@ possibly an associated capability specification. Each key is associated with an entity name, of the form ``{client,mon,mds,osd}.name``. -**WARNING** Ceph provides authentication and protection against +**WARNING:** Ceph provides authentication and protection against man-in-the-middle attacks once secret keys are in place. However, data over the wire is not encrypted, which may include the messages used to configure said keys. The system is primarily intended to be @@ -85,7 +85,7 @@ Options .. option:: --mode *mode* - will set the desired file mode to the keyring e.g: 0644, defaults to 0600 + will set the desired file mode to the keyring e.g.: 0644, defaults to 0600 Capabilities @@ -95,7 +95,7 @@ The subsystem is the name of a Ceph subsystem: ``mon``, ``mds``, or ``osd``. The capability is a string describing what the given user is allowed -to do. This takes the form of a comma separated list of allow +to do. This takes the form of a comma-separated list of allow clauses with a permission specifier containing one or more of rwx for read, write, and execute permission. The ``allow *`` grants full superuser permissions for the given subsystem. diff --git a/doc/man/8/ceph-bluestore-tool.rst b/doc/man/8/ceph-bluestore-tool.rst index 9e1dd31ac2ec..a958b298d491 100644 --- a/doc/man/8/ceph-bluestore-tool.rst +++ b/doc/man/8/ceph-bluestore-tool.rst @@ -54,7 +54,7 @@ Commands :command:`fsck` [ --deep ] *(on|off) or (yes|no) or (1|0) or (true|false)* - run consistency check on BlueStore metadata. If *--deep* is specified, also read all object data and verify checksums. + Run a consistency check on BlueStore metadata. If *--deep* is specified, also read all object data and verify checksums. :command:`repair` @@ -62,11 +62,11 @@ Commands :command:`qfsck` - run consistency check on BlueStore metadata comparing allocator data (from RocksDB CFB when exists and if not uses allocation-file) with ONodes state. + Run a consistency check on BlueStore metadata comparing allocator data (from RocksDB CFB when exists; and if not, uses allocation-file) with ONodes state. :command:`allocmap` - performs the same check done by qfsck and then stores a new allocation-file (command is disabled by default and requires a special build) + Performs the same check done by qfsck and then stores a new allocation-file (command is disabled by default and requires a special build). :command:`restore_cfb` @@ -144,8 +144,8 @@ Commands :command:`reshard` --path *osd path* --sharding *new sharding* [ --resharding-ctrl *control string* ] - Changes sharding of BlueStore's RocksDB. Sharding is build on top of RocksDB column families. - This option allows to test performance of *new sharding* without need to redeploy OSD. + Changes sharding of BlueStore's RocksDB. Sharding is built on top of RocksDB column families. + This option allows to test the performance of *new sharding* without the need to redeploy OSD. Resharding is usually a long process, which involves walking through entire RocksDB key space and moving some of them to different column families. Option --resharding-ctrl provides performance control over resharding process. @@ -157,18 +157,18 @@ Commands Show sharding that is currently applied to BlueStore's RocksDB. -:command: `trim` --path *osd path* +:command:`trim` --path *osd path* An SSD that has been used heavily may experience performance degradation. This operation uses TRIM / discard to free unused blocks from BlueStore and BlueFS block devices, and allows the drive to perform more efficient internal housekeeping. If BlueStore runs with discard enabled, this option may not be useful. -:command: `zap-device` --dev *dev path* +:command:`zap-device` --dev *dev path* Zeros all device label locations. This effectively makes device appear empty. -:command: `revert-wal-to-plain` --path *osd path* +:command:`revert-wal-to-plain` --path *osd path* Changes WAL files from envelope mode to the legacy plain mode. Useful for downgrades, or if you might want to disable this new feature (bluefs_wal_envelope_mode). @@ -190,8 +190,8 @@ Options .. option:: -i *osd_id* - Operate as OSD *osd_id*. Connect to monitor for OSD specific options. - If monitor is unavailable, add --no-mon-config to read from ceph.conf instead. + Operate as OSD *osd_id*. Connect to Monitors for OSD-specific options. + If Monitor is unavailable, add --no-mon-config to read from ceph.conf instead. .. option:: --devs-source *device* @@ -228,7 +228,7 @@ Options .. option:: --resharding-ctrl *control string* - Provides control over resharding process. Specifies how often refresh RocksDB iterator, + Provides control over the resharding process. Specifies how often to refresh RocksDB iterator, and how large should commit batch be before committing to RocksDB. Option format is: /// Default: 10000000/10000/1000000/1000 @@ -237,13 +237,13 @@ Additional ceph.conf options ============================ Any configuration option that is accepted by OSD can be also passed to **ceph-bluestore-tool**. -Useful to provide necessary configuration options when access to monitor/ceph.conf is impossible and -i option cannot be used. +Useful to provide necessary configuration options when access to the Monitors or ceph.conf is impossible and the -i option cannot be used. Device labels ============= Every BlueStore block device has a block label at the beginning of the device. -Main device might optionaly have additional labels at different locations +The main device might optionally have additional labels at different locations for the sake of OSD robustness. You can dump the contents of the label with:: @@ -280,7 +280,7 @@ It is advised to first check if rescue process would be successful:: ceph-bluestore-tool fsck --path *osd path* \ --bluefs_replay_recovery=true --bluefs_replay_recovery_disable_compact=true -If above fsck is successful fix procedure can be applied. +If above fsck is successful, the fix procedure can be applied. Availability ============ diff --git a/doc/man/8/ceph-conf.rst b/doc/man/8/ceph-conf.rst index 4fea4d43d7fb..e8879c1b2a3c 100644 --- a/doc/man/8/ceph-conf.rst +++ b/doc/man/8/ceph-conf.rst @@ -20,22 +20,22 @@ Synopsis Description =========== -**ceph-conf** is a utility for getting information from a ceph +**ceph-conf** is a utility for getting information from a Ceph configuration file. As with most Ceph programs, you can specify which Ceph configuration file to use with the ``-c`` flag. -Note that unlike other ceph tools, **ceph-conf** will *only* read from +Note that unlike other Ceph tools, **ceph-conf** will *only* read from config files (or return compiled-in default values)--it will *not* -fetch config values from the monitor cluster. For this reason it is +fetch config values from the Monitor cluster. For this reason it is recommended that **ceph-conf** only be used in legacy environments that are strictly config-file based. New deployments and tools should -instead rely on either querying the monitor explicitly for +instead rely on either querying the Monitors' central config store explicitly for configuration (e.g., ``ceph config get