doc: unify section headings to gerund phrases

Use -ing headings for sections across the user manual.
2026-07-05 14:55:10 +00:00 · 2026-05-15 23:20:38 +02:00
parent 4c9a07e9c8
commit 75f92f22d9
7 changed files with 32 additions and 32 deletions
@@ -557,8 +557,8 @@ Finding things in the repository
 The ``restic find`` command searches for files or directories stored
 in the repository.

-find files and directories
--------------------------
+Finding files and directories
+-----------------------------

 If you want to find files or directories in the repository, you either specify filename(s)
 or a pattern which represents filename(s).
@@ -587,8 +587,8 @@ The following example searches for files which have a modification date in the y
 All these commands work in ``--json`` mode as well, for output details for the
 various options please refer to :ref:`find`.

-find blobs, trees or packfiles
------------------------------
+Finding blobs, trees, or packfiles
+----------------------------------

 The other options of the ``find`` command are devoted to finding blobs, trees and packfiles.
 These are typically not used by the normal user, but can help debugging a problem
@@ -134,8 +134,8 @@ values are supported:
  newer modification time (mtime).
 * ``--overwrite never``: never overwrite existing files.

-Delete files not in snapshot
----------------------------
+Deleting files not in snapshot
+------------------------------

 When restoring into a directory that already contains files, it can be useful to remove all
 files that do not exist in the snapshot. For this, pass the ``--delete`` option to the ``restore``
@@ -186,8 +186,8 @@ To reliably determine which files would be updated, a dry-run also verifies the
 already existing files according to the specified overwrite behavior. To skip these checks
 either specify ``--overwrite never`` or specify a non-existing ``--target`` directory.

-Restore using mount
-===================
+Restoring using mount
+=====================

 Browsing your backup as a regular file system is also very easy. First,
 create a mount point such as ``/mnt/restic`` and then use the following
@@ -32,8 +32,8 @@ It is advisable to run ``restic check`` after pruning, to make sure
 you are alerted, should the internal data structures of the repository
 be damaged.

-Remove a single snapshot
-************************
+Removing a single snapshot
+**************************

 The command ``snapshots`` can be used to list all snapshots in a
 repository like this:
@@ -446,8 +446,8 @@ all legitimate snapshots.

 .. _customize-pruning:

-Customize pruning
-*****************
+Customizing pruning
+*******************

 To understand the custom options, this section first explains how the pruning process works:

@@ -21,9 +21,9 @@ it. So… I’m going to use restic for my personal backups.*" `Filippo Valsorda

 .. _Filippo Valsorda: https://words.filippo.io/restic-cryptography/

-**********************
-Manage repository keys
-**********************
+************************
+Managing repository keys
+************************

 The ``key`` command allows you to set multiple access keys or passwords
 per repository. In fact, you can use the ``list``, ``add``, ``remove``, and
@@ -116,8 +116,8 @@ The external programs that restic may execute include ``rclone`` (for rclone
 backends) and ``ssh`` (for the SFTP backend). These may respond to further
 environment variables and configuration files; see their respective manuals.

-Check if a repository is already initialized
-********************************************
+Checking if a repository is already initialized
+***********************************************

 You may find a need to check if a repository is already initialized,
 perhaps to prevent your script from trying to initialize a repository multiple
@@ -41,8 +41,8 @@ bugfixes, and improvements to simplify the repair of a repository. It might also
 contain a fix for your repository problems!


-1. Find out what is damaged
-***************************
+1. Finding damaged data
+***********************

 The first step is always to check the repository.

@@ -81,7 +81,7 @@ somewhere. Please include the check output and additional information that might
 help locate the problem.

 If ``check`` detects damaged pack files, it will show instructions on how to repair
-them using the ``repair packs`` command. Use that command instead of the "Repair the
+them using the ``repair packs`` command. Use that command instead of the "Repairing the
 index" section in this guide.

 If you are interested to check only specific snapshots, you can now
@@ -91,8 +91,8 @@ will then be checked for consistency and read when either ``--read-data`` or
 ``--read-data-subset`` is given.


-2. Backup the repository
-************************
+2. Backing up the repository
+****************************

 Create a full copy of the repository if possible. Or at the very least make a
 copy of the ``index`` and ``snapshots`` folders. This will allow you to roll back
@@ -115,8 +115,8 @@ whether your issue is already known and solved. Please take a look at the
 `forum`_ and `GitHub issues <https://github.com/restic/restic/issues>`_.


-3. Repair the index
-*******************
+3. Repairing the index
+**********************

 .. note::

@@ -149,8 +149,8 @@ Please note that it is not recommended to repair the index unless the repository
 is actually damaged.


-4. Run all backups (optional)
-*****************************
+4. Running all backups (optional)
+*********************************

 With a correct index, the ``backup`` command guarantees that newly created
 snapshots can be restored successfully. It can also heal older snapshots,
@@ -165,8 +165,8 @@ To check if the repository is fully repaired, you can run ``restic check``
 To get a list of still damaged files, you can run ``restic repair snapshots --dry-run``.
 Look for ``would save new snapshot`` messages to find affected snapshots.

-5. Remove missing data from snapshots
-*************************************
+5. Removing missing data from snapshots
+***************************************

 If your repository is still missing data, then you can use the ``repair snapshots``
 command to remove all inaccessible data from the snapshots. That is, this will
@@ -191,8 +191,8 @@ modified snapshots using the ``forget`` command. In the example above, you'd hav
 to run ``restic forget 6979421e``.


-6. Check the repository again
-*****************************
+6. Checking the repository again
+********************************

 As a final step, run ``check`` again to make sure that the repository has been successfully
 repaired.
@@ -183,8 +183,8 @@ on the status at will.
 Setting the `RESTIC_PROGRESS_FPS` environment variable or sending a `SIGUSR1`
 signal prints a status report even when `--quiet` was specified.

-Manage tags
-----------
+Managing tags
+-------------

 Managing tags on snapshots is done with the ``tag`` command. The
 existing set of tags can be replaced completely, tags can be added or