From e212076f71451a445eb643a5450ff410bca1772f Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Fri, 15 May 2026 23:36:47 +0200 Subject: [PATCH] doc: correctly use RST backticks RST uses double backticks for inline code unlike the single backticks in Markdown. --- doc/020_installation.rst | 4 ++-- doc/030_preparing_a_new_repo.rst | 2 +- doc/040_backup.rst | 2 +- doc/045_working_with_repos.rst | 4 ++-- doc/047_tuning_parameters.rst | 4 ++-- doc/050_restore.rst | 2 +- doc/060_forget.rst | 8 ++++---- doc/075_scripting.rst | 2 +- doc/077_troubleshooting.rst | 2 +- doc/design.rst | 8 ++++---- doc/faq.rst | 12 ++++++------ doc/manual_rest.rst | 4 ++-- 12 files changed, 27 insertions(+), 27 deletions(-) diff --git a/doc/020_installation.rst b/doc/020_installation.rst index 1e4dc8e56..ea09f2a44 100644 --- a/doc/020_installation.rst +++ b/doc/020_installation.rst @@ -268,7 +268,7 @@ Docker container **************** A minimal Docker image with just a few files and the restic -binary is available; you can get it with `docker pull` like this: +binary is available; you can get it with ``docker pull`` like this: .. code-block:: console @@ -281,7 +281,7 @@ The container is also available on the GitHub Container Registry: $ docker pull ghcr.io/restic/restic Restic relies on the hostname for various operations. Make sure to set a static -hostname using `--hostname` when creating a Docker container, otherwise Docker +hostname using ``--hostname`` when creating a Docker container, otherwise Docker will assign a random hostname each time. The container additionally honors traditional ``nice`` `(man page) `__ and ``ionice`` `(man page) `__ directives via the following environment variables. diff --git a/doc/030_preparing_a_new_repo.rst b/doc/030_preparing_a_new_repo.rst index 548e50609..dc1fbdb8d 100644 --- a/doc/030_preparing_a_new_repo.rst +++ b/doc/030_preparing_a_new_repo.rst @@ -89,7 +89,7 @@ command and enter the same password twice: On Linux, storing the backup repository on a CIFS (SMB) share or backing up data from a CIFS share is not recommended due to compatibility issues in older Linux kernels. Either use another backend or set the environment - variable `GODEBUG` to `asyncpreemptoff=1`. Refer to GitHub issue + variable ``GODEBUG`` to ``asyncpreemptoff=1``. Refer to GitHub issue :issue:`2659` for further explanations. SFTP diff --git a/doc/040_backup.rst b/doc/040_backup.rst index 6051d4ee8..63d06f741 100644 --- a/doc/040_backup.rst +++ b/doc/040_backup.rst @@ -508,7 +508,7 @@ include other filesystems like ``/sys`` and ``/proc``. .. note:: ``--one-file-system`` is currently unsupported on Windows, and will cause the backup to immediately fail with an error. -Files larger than a given size can be excluded using the `--exclude-larger-than` +Files larger than a given size can be excluded using the ``--exclude-larger-than`` option: .. code-block:: console diff --git a/doc/045_working_with_repos.rst b/doc/045_working_with_repos.rst index e32914a69..9aff3ab0f 100644 --- a/doc/045_working_with_repos.rst +++ b/doc/045_working_with_repos.rst @@ -265,7 +265,7 @@ or the environment variable ``$RESTIC_FROM_KEY_HINT``. repository. You can avoid this limitation by using the rclone backend along with remotes which are configured in rclone. -.. note:: If `copy` is aborted, `copy` will resume the interrupted copying when it is run again. It's possible that up to 10 minutes of progress can be lost because the repository index is only updated from time to time. +.. note:: If ``copy`` is aborted, ``copy`` will resume the interrupted copying when it is run again. It's possible that up to 10 minutes of progress can be lost because the repository index is only updated from time to time. .. _copy-filtering-snapshots: @@ -447,7 +447,7 @@ detect this and yield the same error as when you tried to restore: load indexes error: error loading index de30f3231ca2e6a59af4aa84216dfe2ef7339c549dc11b09b84000997b139628: LoadRaw(): invalid data returned - The repository index is damaged and must be repaired. You must run `restic repair index' to correct this. + The repository index is damaged and must be repaired. You must run ``restic repair index`` to correct this. Fatal: repository contains errors diff --git a/doc/047_tuning_parameters.rst b/doc/047_tuning_parameters.rst index e05dd6da1..73cd3606b 100644 --- a/doc/047_tuning_parameters.rst +++ b/doc/047_tuning_parameters.rst @@ -48,8 +48,8 @@ CPU usage ========= By default, restic uses all available CPU cores. You can set the environment variable -`GOMAXPROCS` to limit the number of used CPU cores. For example to use a single CPU core, -use `GOMAXPROCS=1`. Limiting the number of usable CPU cores can slightly reduce the memory +``GOMAXPROCS`` to limit the number of used CPU cores. For example to use a single CPU core, +use ``GOMAXPROCS=1``. Limiting the number of usable CPU cores can slightly reduce the memory usage of restic. diff --git a/doc/050_restore.rst b/doc/050_restore.rst index 5e6c8ead5..6cf2f0145 100644 --- a/doc/050_restore.rst +++ b/doc/050_restore.rst @@ -223,7 +223,7 @@ Printing files to stdout ======================== Sometimes it's helpful to print files to stdout so that other programs can read -the data directly. This can be achieved by using the `dump` command, like this: +the data directly. This can be achieved by using the ``dump`` command, like this: .. code-block:: console diff --git a/doc/060_forget.rst b/doc/060_forget.rst index 503ecb697..ca5f85a6b 100644 --- a/doc/060_forget.rst +++ b/doc/060_forget.rst @@ -280,8 +280,8 @@ might be spread over a longer period. If what you want is to keep daily snapshots for the last week, weekly for the last month, monthly for the last year and yearly for the last 75 years, you can instead specify ``forget --keep-within-daily 7d --keep-within-weekly 1m --keep-within-monthly 1y ---keep-within-yearly 75y`` (note that `1w` is not a recognized duration, so -you will have to specify `7d` instead). +--keep-within-yearly 75y`` (note that ``1w`` is not a recognized duration, so +you will have to specify ``7d`` instead). The processed snapshots are evaluated against all ``--keep-*`` options but a snapshot only needs to match a single option to be kept (the results are ORed). @@ -531,8 +531,8 @@ is available as a method of last resort. It allows prune to work with little to space. However, a **failed** ``prune`` run can cause the repository to become **temporarily unusable**. Therefore, make sure that you have a stable connection to the repository storage, before running this command. In case the command fails, it may become -necessary to manually remove all files from the `index/` folder of the repository and -run `repair index` afterwards. +necessary to manually remove all files from the ``index/`` folder of the repository and +run ``restic repair index`` afterwards. To prevent accidental usages of the ``--unsafe-recover-no-free-space`` option it is necessary to first run ``prune --unsafe-recover-no-free-space SOME-ID`` and then replace diff --git a/doc/075_scripting.rst b/doc/075_scripting.rst index ec0585a0e..1ed51ad82 100644 --- a/doc/075_scripting.rst +++ b/doc/075_scripting.rst @@ -761,7 +761,7 @@ Verbose status ^^^^^^^^^^^^^^ Verbose status provides details about the progress, including details about restored files. -Only printed if `--verbose=2` is specified. +Only printed if ``--verbose=2`` is specified. +------------------+--------------------------------------------------------+--------+ | ``message_type`` | Always "verbose_status" | string | diff --git a/doc/077_troubleshooting.rst b/doc/077_troubleshooting.rst index 3a0ef3c18..44cf8456a 100644 --- a/doc/077_troubleshooting.rst +++ b/doc/077_troubleshooting.rst @@ -120,7 +120,7 @@ whether your issue is already known and solved. Please take a look at the .. note:: - If the `check` command tells you to run `restic repair packs`, then use that + If the ``check`` command tells you to run ``restic repair packs``, then use that command instead. It will repair the damaged pack files and also update the index. Restic relies on its index to contain correct information about what data is diff --git a/doc/design.rst b/doc/design.rst index 07ab6f3e5..e526d4970 100644 --- a/doc/design.rst +++ b/doc/design.rst @@ -572,11 +572,11 @@ A symlink uses the following data structure: ] } -The symlink target is stored in the field `linktarget`. As JSON strings can -only contain valid unicode, an exception applies if the `linktarget` is not a -valid UTF-8 string. Since restic 0.16.0, in such a case the `linktarget_raw` +The symlink target is stored in the field ``linktarget``. As JSON strings can +only contain valid unicode, an exception applies if the ``linktarget`` is not a +valid UTF-8 string. Since restic 0.16.0, in such a case the ``linktarget_raw`` field contains a base64 encoded version of the raw linktarget. The -`linktarget_raw` field is only set if `linktarget` cannot be encoded correctly. +``linktarget_raw`` field is only set if ``linktarget`` cannot be encoded correctly. The command ``restic cat blob`` can also be used to extract and decrypt data given a plaintext ID, e.g. for the data mentioned above: diff --git a/doc/faq.rst b/doc/faq.rst index 329c54479..204db22ee 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -46,7 +46,7 @@ looks like this: pack 819a9a52e4f51230afa89aefbf90df37fb70996337ae57e6f7a822959206a85e: not referenced in any index pack de299e69fb075354a3775b6b045d152387201f1cdc229c31d1caa34c3b340141: not referenced in any index 2 additional files were found in the repo, which likely contain duplicate data. - You can run `restic prune` to correct this. + You can run ``restic prune`` to correct this. check snapshots, trees and blobs [0:00] 100.00% 16 / 16 snapshots no errors were found @@ -283,14 +283,14 @@ Archive** storage classes is available: in the future (although the project will make best-effort attempts to avoid them). - Expect restores to hang from 1 up to 42 hours depending on your storage class, provider and luck. Restores from cold storages are known to be - time-consuming. You may need to adjust the `s3.restore-timeout` if a restore + time-consuming. You may need to adjust the ``s3.restore-timeout`` option if a restore operation takes more than 24 hours. - Restic will prevent sending metadata files (such as config files, lock files or tree blobs) to Glacier or Deep Archive. Standard class is used instead to ensure normal and fast operations for most tasks. - Currently, only the following commands are known to work: - - `backup` - - `copy` - - `prune` - - `restore` + - ``backup`` + - ``copy`` + - ``prune`` + - ``restore`` diff --git a/doc/manual_rest.rst b/doc/manual_rest.rst index 4cb830ef2..18c782769 100644 --- a/doc/manual_rest.rst +++ b/doc/manual_rest.rst @@ -180,8 +180,8 @@ Additionally, on Unix systems if ``restic`` receives a SIGUSR1 signal the current progress will be written to the standard output so you can check up 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. +Setting the ``RESTIC_PROGRESS_FPS`` environment variable or sending a ``SIGUSR1`` +signal prints a status report even when ``--quiet`` was specified. Managing tags -------------