From 55b440b520163bbf272e0b4168f224be1230fbb4 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sun, 16 Jul 2023 21:43:56 +0200 Subject: [PATCH] tweak snapshot:subfolder docs --- changelog/unreleased/issue-3871 | 8 ++++---- doc/040_backup.rst | 2 +- doc/050_restore.rst | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/changelog/unreleased/issue-3871 b/changelog/unreleased/issue-3871 index e3bf5fc01..786e902d4 100644 --- a/changelog/unreleased/issue-3871 +++ b/changelog/unreleased/issue-3871 @@ -6,10 +6,10 @@ did not allow comparing only a specific subfolder or only restoring that folder directories included in `subfolder`). The commands `diff`, `dump`, `ls`, `restore` now support the -`:` syntax, where `snapshot` is the ID of a snapshot or -`latest` and `subfolder` is a path within the snapshot. The commands will then -only work with the specified path of the snapshot. The `subfolder` must be a -path to a folder as returned by `ls`. +`:` syntax, where `snapshot` is the ID of a snapshot (or +the string `latest`) and `subfolder` is a path within the snapshot. The +commands will then only work with the specified path of the snapshot. The +`subfolder` must be a path to a folder as returned by `ls`. `restic restore -t target latest:/some/path` `restic diff 12345678:/some/path 90abcef:/some/path` diff --git a/doc/040_backup.rst b/doc/040_backup.rst index f56610507..1655e7eed 100644 --- a/doc/040_backup.rst +++ b/doc/040_backup.rst @@ -452,7 +452,7 @@ and displays a small statistic, just pass the command two snapshot IDs: Removed: 16.402 MiB To only compare files in specific subfolders, you can use the ``:`` -syntax, where ``snapshot`` is the ID of a snapshot or ``latest`` and ``subfolder`` +syntax, where ``snapshot`` is the ID of a snapshot (or the string ``latest``) and ``subfolder`` is a path within the snapshot. For example, to only compare files in the ``/restic`` folder, you could use the following command: diff --git a/doc/050_restore.rst b/doc/050_restore.rst index e9fa4e327..ed2ddfd40 100644 --- a/doc/050_restore.rst +++ b/doc/050_restore.rst @@ -49,8 +49,8 @@ files in the snapshot. For example, to restore a single file: This will restore the file ``foo`` to ``/tmp/restore-work/work/foo``. To only restore a specific subfolder, you can use the ``:`` -syntax, where ``snapshot`` is the ID of a snapshot or ``latest`` and ``subfolder`` -is a path within the snapshot. +syntax, where ``snapshot`` is the ID of a snapshot (or the string ``latest``) +and ``subfolder`` is a path within the snapshot. .. code-block:: console