From 42fb25d4a7ba16c781d2bcce54466c074d8b6f58 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Mon, 7 Feb 2022 21:40:15 +0100 Subject: [PATCH] docs: use same phrasing in misc. help texts --- src/borg/archiver.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/borg/archiver.py b/src/borg/archiver.py index 12f53a568..510311eea 100644 --- a/src/borg/archiver.py +++ b/src/borg/archiver.py @@ -3328,16 +3328,15 @@ class Archiver: the state after creation. Also, the ``--stats`` and ``--dry-run`` options are mutually exclusive because the data is not actually compressed and deduplicated during a dry run. - See the output of the "borg help patterns" command for more help on exclude patterns. + For more help on include/exclude patterns, see the ``borg help patterns`` command output. - See the output of the "borg help placeholders" command for more help on placeholders. + For more help on placeholders, see the ``borg help placeholders`` command output. .. man NOTES The ``--exclude`` patterns are not like tar. In tar ``--exclude`` .bundler/gems will exclude foo/.bundler/gems. In borg it will not, you need to use ``--exclude`` - '\\*/.bundler/gems' to get the same effect. See ``borg help patterns`` for - more information. + '\\*/.bundler/gems' to get the same effect. In addition to using ``--exclude`` patterns, it is possible to use ``--exclude-if-present`` to specify the name of a filesystem object (e.g. a file @@ -3808,7 +3807,7 @@ class Archiver: pass ``--same-chunker-params``. Note that the chunker params changed from Borg 0.xx to 1.0. - See the output of the "borg help patterns" command for more help on exclude patterns. + For more help on include/exclude patterns, see the ``borg help patterns`` command output. """) subparser = subparsers.add_parser('diff', parents=[common_parser], add_help=False, description=self.do_diff.__doc__, @@ -3869,7 +3868,7 @@ class Archiver: can be selected by passing a list of ``PATHs`` as arguments. The file selection can further be restricted by using the ``--exclude`` option. - See the output of the "borg help patterns" command for more help on exclude patterns. + For more help on include/exclude patterns, see the ``borg help patterns`` command output. ``--progress`` can be slower than no progress display, since it makes one additional pass over the archive metadata. @@ -3900,7 +3899,7 @@ class Archiver: by passing a list of ``PATHs`` as arguments. The file selection can further be restricted by using the ``--exclude`` option. - See the output of the "borg help patterns" command for more help on exclude patterns. + For more help on include/exclude patterns, see the ``borg help patterns`` command output. By using ``--dry-run``, you can do all extraction steps except actually writing the output data: reading metadata and data chunks from the repo, checking the hash/hmac, @@ -4266,7 +4265,7 @@ class Archiver: list_epilog = process_epilog(""" This command lists the contents of a repository or an archive. - See the "borg help patterns" command for more help on exclude patterns. + For more help on include/exclude patterns, see the ``borg help patterns`` command output. .. man NOTES