btrfs-progs: docs: use command role for programs or command lines

Replace **bold** or ``quoted`` with :command:`line ...` that is supposed
to be used verbatim.

Signed-off-by: David Sterba <[email protected]>

Author: kdave

Documentation/Common-features.rst

@@ -20,12 +20,11 @@ fallocate modes
         holes, preallocation or zeroing a range
 
 FIEMAP
-        an ioctl that enumerates file extents, related tool is ``filefrag``
+        an ioctl that enumerates file extents, related tool is :command:`filefrag`
 
 filesystem label
         another filesystem identification, could be used for mount or for better
-        recognition, can be set or read by an ioctl or by command ``btrfs
-        filesystem label``
+        recognition, can be set or read by an ioctl or by command :command:`btrfs filesystem label`
 
 O_TMPFILE
         mode of open() syscall that creates a file with no associated directory
@@ -36,8 +35,7 @@ O_TMPFILE
 xattr, acl
         extended attributes (xattr) is a list of *key=value* pairs associated
         with a file, usually storing additional metadata related to security,
-        access control list in particular (ACL) or properties (``btrfs
-        property``)
+        access control list in particular (ACL) or properties (:command:`btrfs property`)
 
 cross-rename
         mode of *renameat2* syscall that can atomically swap 2 directory

Documentation/Custom-ioctls.rst

@@ -6,17 +6,16 @@ call interface to let user applications access the advanced features. They're
 low level and the following list gives only an overview of the capabilities or
 a command if available:
 
-- reverse lookup, from file offset to inode, as command ``btrfs
-  inspect-internal logical-resolve``
+- reverse lookup, from file offset to inode, as command :command:`btrfs inspect-internal logical-resolve`
 
-- resolve inode number to list of names, as command ``btrfs inspect-internal inode-resolve``
+- resolve inode number to list of names, as command :command:`btrfs inspect-internal inode-resolve`
 
 - tree search, given a key range and tree id, lookup and return all b-tree items
   found in that range, basically all metadata at your hand but you need to know
   what to do with them, the ioctl is privileged as it has full access to all
   filesystem metadata
 
 - informative, about devices, space allocation or the whole filesystem, many of
-  which is also exported in ``/sys/fs/btrfs``
+  which is also exported in :file:`/sys/fs/btrfs/`
 
 - query/set a subset of features on a mounted filesystem

Documentation/Feature-by-version.rst

@@ -282,7 +282,7 @@ features see [[Status]] page.
 5.0 - metadata uuid
         An optional incompat feature to assign a new filesystem UUID without
         overwriting all metadata blocks, stored only in superblock, unlike what
-        ``btrfstune -u``
+        :command:`btrfstune -u`
 
 5.1 - FORGET_DEV ioctl
         Unregister devices previously added by the scan ioctl, same effect as
@@ -315,7 +315,7 @@ features see [[Status]] page.
 
 5.7 - faster balance cancel
         More cancellation points in balance that will shorten the time to stop
-        processing once ``btrfs balance cancel`` is called.
+        processing once :command:`btrfs balance cancel` is called.
 
 5.7 - *removed flag BTRFS_SUBVOL_CREATE_ASYNC*
         Remove support of flag BTRFS_SUBVOL_CREATE_ASYNC from subvolume creation ioctl.

Documentation/Glossary.rst

@@ -14,7 +14,7 @@ allocator
 
 balance
 	An operation that can be done to a btrfs filesystem, for example
-	through ``btrfs fi balance /path``. A
+	through :command:`btrfs fi balance /path`. A
 	balance passes all data in the filesystem through the *allocator*
 	again. It is primarily intended to rebalance the data in the filesystem
 	across the *devices* when a device is added or removed. A balance
@@ -247,11 +247,11 @@ RAID-10
 	performance.
 
 reflink
-	Parameter to ``cp``, allowing it to take advantage of the
+	Parameter to :command:`cp`, allowing it to take advantage of the
 	capabilities of *COW*-capable filesystems. Allows for files to be
 	copied and modified, with only the modifications taking up additional
 	storage space. May be considered as *snapshots* on a single file rather
-	than a *subvolume*. Example: ``cp --reflink file1 file2``
+	than a *subvolume*. Example: :command:`cp --reflink file1 file2`
 
 relocation
 	The process of moving block groups within the filesystem while

Documentation/Inline-files.rst

@@ -12,7 +12,7 @@ It can be completely disabled by mounting with ``max_inline=0``. The upper
 limit is either the size of b-tree node or the page size of the host.
 
 An inline file can be identified by enumerating the extents, e.g. by the tool
-``filefrag``:
+:command:`filefrag`:
 
 .. code-block:: bash
 

Documentation/Subpage.rst

@@ -10,7 +10,7 @@ pages, like 64KiB on 64bit ARM or PowerPC. This means filesystems created
 with 64KiB sector size cannot be mounted on a system with 4KiB page size.
 
 While with subpage support, systems with 64KiB page size can create (still needs
-"-s 4k" option for mkfs.btrfs) and mount filesystems with 4KiB sectorsize,
+"-s 4k" option for :command:`mkfs.btrfs`) and mount filesystems with 4KiB sectorsize,
 allowing us to push 4KiB sectorsize as default sectorsize for all platforms in the
 near future.
 

Documentation/Trim.rst

@@ -26,7 +26,7 @@ asynchronous
         with the rest of the filesystem activity
 
 manually by fstrim
-        the tool ``fstrim`` starts a trim operation on the whole filesystem, no
+        the tool :command:`fstrim` starts a trim operation on the whole filesystem, no
         mount options need to be specified, so it's up to the filesystem to
         traverse the free space and start the trim, this is suitable for running
         it as periodic service

Documentation/btrfs-check.rst

@@ -14,10 +14,10 @@ and attempt to repair it if requested.  It is recommended to unmount the
 filesystem prior to running the check, but it is possible to start checking a
 mounted filesystem (see *--force*).
 
-By default, **btrfs check** will not modify the device but you can reaffirm that
+By default, :command:`btrfs check` will not modify the device but you can reaffirm that
 by the option *--readonly*.
 
-**btrfsck** is an alias of **btrfs check** command and is now deprecated.
+:command:`btrfsck` is an alias of :command:`btrfs check` command and is now deprecated.
 
 .. warning::
    Do not use *--repair* unless you are advised to do so by a developer

Documentation/btrfs-device.rst

@@ -9,7 +9,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-The **btrfs device** command group is used to manage devices of the btrfs filesystems.
+The :command:`btrfs device` command group is used to manage devices of the btrfs filesystems.
 
 DEVICE MANAGEMENT
 -----------------

Documentation/btrfs-filesystem.rst

@@ -9,7 +9,7 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-**btrfs filesystem** is used to perform several whole filesystem level tasks,
+:command:`btrfs filesystem` is used to perform several whole filesystem level tasks,
 including all the regular filesystem operations like resizing, space stats,
 label setting/getting, and defragmentation. There are other whole filesystem
 tasks like scrub or balance that are grouped in separate commands.
@@ -26,7 +26,7 @@ df [options] <path>
 
         * device size: *1.9TiB*, one device, no RAID
         * filesystem size: *1.9TiB*
-        * created with: **mkfs.btrfs -d single -m single**
+        * created with: :command:`mkfs.btrfs -d single -m single`
 
         .. code-block:: none
 
@@ -94,7 +94,7 @@ defragment [options] <file>|<dir> [<file>|<dir>...]
         .. warning::
                 Defragmenting with Linux kernel versions < 3.9 or ≥ 3.14-rc2 as well as
                 with Linux stable kernel versions ≥ 3.10.31, ≥ 3.12.12 or ≥ 3.13.4 will break up
-                the reflinks of COW data (for example files copied with **cp --reflink**,
+                the reflinks of COW data (for example files copied with :command:`cp --reflink`,
                 snapshots or de-duplicated data).
                 This may cause considerable increase of space usage depending on the broken up
                 reflinks.
@@ -146,7 +146,7 @@ du [options] <path> [<path>..]
         shared) bytes. We also calculate a 'set shared' value which is
         described below.
 
-        Each argument to **btrfs filesystem du** will have a *set shared* value
+        Each argument to :command:`btrfs filesystem du` will have a *set shared* value
         calculated for it. We define each *set* as those files found by a
         recursive search of an argument (recursion descends to subvolumes but not
         mount points). The *set shared* value then is a sum of all shared space
@@ -197,8 +197,9 @@ mkswapfile [-s size] file
         activated swapfile cannot be balanced.
 
         Swapfile creation can be achieved by standalone commands too. Activation
-        needs to be done by command ``swapon(8)``. See also command ``btrfs
-        inspect-internal map-swapfile`` and the :doc:`Swapfile feature<Swapfile>` description.
+        needs to be done by command ``swapon(8)``. See also command
+        :command:`btrfs inspect-internal map-swapfile`
+        and the :doc:`Swapfile feature<Swapfile>` description.
 
         .. note::
                 The command is a simplified version of 'mkswap', if you want to set
@@ -223,7 +224,7 @@ resize [options] [<devid>:][+/-]<size>[kKmMgGtTpPeE]|[<devid>:]max <path>
                 as expected and does not resize the image. This would resize the underlying
                 filesystem instead.
 
-        The *devid* can be found in the output of **btrfs filesystem show** and
+        The *devid* can be found in the output of :command:`btrfs filesystem show` and
         defaults to 1 if not specified.
         The *size* parameter specifies the new size of the filesystem.
         If the prefix *+* or *-* is present the size is increased or decreased
@@ -291,11 +292,11 @@ show [options] [<path>|<uuid>|<device>|<label>]
 sync <path>
         Force a sync of the filesystem at *path*, similar to the ``sync(1)`` command. In
         addition, it starts cleaning of deleted subvolumes. To wait for the subvolume
-        deletion to complete use the **btrfs subvolume sync** command.
+        deletion to complete use the :command:`btrfs subvolume sync` command.
 
 usage [options] <path> [<path>...]
         Show detailed information about internal filesystem usage. This is supposed to
-        replace the **btrfs filesystem df** command in the long run.
+        replace the :command:`btrfs filesystem df` command in the long run.
 
         The level of detail can differ if the command is run under a regular or the
         root user (due to use of restricted ioctl). For both there's a summary section
@@ -461,7 +462,7 @@ simply using *max* as size we will achieve that.
 
 .. note::
    There are two ways to minimize the filesystem on a given device. The
-   **btrfs inspect-internal min-dev-size** command, or iteratively shrink in steps.
+   :command:`btrfs inspect-internal min-dev-size` command, or iteratively shrink in steps.
 
 EXIT STATUS
 -----------