upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-05-28 04:03:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Merge pull request #6322 from hexagonrecursion/bp-links

Browse source 
Backport:  improve linking inside docs
This commit is contained in:
TW 2022-02-20 16:45:54 +01:00 committed by GitHub
commit dd83a71adf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/borg/archiver.py
View file

@ -2753,6 +2753,8 @@ class Archiver:
rst_plain_text_references = {
'a_status_oddity': '"I am seeing ‘A’ (added) status for a unchanged file!?"',
'list_item_flags': '"Item flags"',
'borg_patterns': '"borg help patterns"',
'borg_placeholders': '"borg help placeholders"',
'key_files': 'Internals -> Data structures and file formats -> Key files',
'borg_key_export': 'borg key export --help',
}
@ -3444,16 +3446,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 :ref:`borg_patterns` command output.
See the output of the "borg help placeholders" command for more help on placeholders.
For more help on placeholders, see the :ref:`borg_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
@ -3631,7 +3632,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 :ref:`borg_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,
@ -3708,7 +3709,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 :ref:`borg_patterns` command output.
``--progress`` can be slower than no progress display, since it makes one additional
pass over the archive metadata.
@ -3748,7 +3749,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 :ref:`borg_patterns` command output.
""")
subparser = subparsers.add_parser('diff', parents=[common_parser], add_help=False,
description=self.do_diff.__doc__,
@ -3830,7 +3831,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 :ref:`borg_patterns` command output.
.. man NOTES