Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve linking inside docs #6263

Merged
merged 5 commits into from
Feb 8, 2022
Merged

improve linking inside docs #6263

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
42fb25d
docs: use same phrasing in misc. help texts
ThomasWaldmann Feb 7, 2022
d79b325
docs: link to borg_patterns
ThomasWaldmann Feb 7, 2022
510ceb8
docs: link to borg_placeholders
ThomasWaldmann Feb 7, 2022
3428b9f
docs: link to python 3.8 docs
ThomasWaldmann Feb 7, 2022
c56b15f
Merge branch 'master' into docs-links-master
ThomasWaldmann Feb 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions src/borg/archiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2452,11 +2452,11 @@ def do_break_lock(self, args, repository):

{now}
The current local date and time, by default in ISO-8601 format.
You can also supply your own `format string <https://docs.python.org/3.5/library/datetime.html#strftime-and-strptime-behavior>`_, e.g. {now:%Y-%m-%d_%H:%M:%S}
You can also supply your own `format string <https://docs.python.org/3.8/library/datetime.html#strftime-and-strptime-behavior>`_, e.g. {now:%Y-%m-%d_%H:%M:%S}

{utcnow}
The current UTC date and time, by default in ISO-8601 format.
You can also supply your own `format string <https://docs.python.org/3.5/library/datetime.html#strftime-and-strptime-behavior>`_, e.g. {utcnow:%Y-%m-%d_%H:%M:%S}
You can also supply your own `format string <https://docs.python.org/3.8/library/datetime.html#strftime-and-strptime-behavior>`_, e.g. {utcnow:%Y-%m-%d_%H:%M:%S}

{user}
The user name (or UID, if no name is available) of the user running borg.
Expand Down Expand Up @@ -2762,6 +2762,8 @@ def build_parser(self):
'a_status_oddity': '"I am seeing ‘A’ (added) status for a unchanged file!?"',
'separate_compaction': '"Separate compaction"',
'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',
}
Expand Down Expand Up @@ -3330,16 +3332,15 @@ def define_borg_mount(parser):
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
Expand Down Expand Up @@ -3758,7 +3759,7 @@ def define_borg_mount(parser):
You can delete multiple archives by specifying their common prefix, if they
have one, using the ``--prefix PREFIX`` option. You can also specify a shell
pattern to match multiple archives using the ``--glob-archives GLOB`` option
(for more info on these patterns, see ``borg help patterns``). Note that these
(for more info on these patterns, see :ref:`borg_patterns`). Note that these
two options are mutually exclusive.

To avoid accidentally deleting archives, especially when using glob patterns,
Expand Down Expand Up @@ -3810,7 +3811,7 @@ def define_borg_mount(parser):
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__,
Expand Down Expand Up @@ -3871,7 +3872,7 @@ def define_borg_mount(parser):
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.
Expand Down Expand Up @@ -3902,7 +3903,7 @@ def define_borg_mount(parser):
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,
Expand Down Expand Up @@ -4286,7 +4287,7 @@ def define_borg_mount(parser):
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

Expand Down