mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-10 06:03:38 +00:00
Code Issues Releases Wiki Activity

docs: less space waste following "Common options"

Browse source
This commit is contained in:
Marian Beermann 2017-06-20 11:53:36 +02:00
parent e5012b11ca
commit a1a92bf00f
27 changed files with 81 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/borg_theme/css/borg.css
View file

@ -169,3 +169,7 @@ cite {
font-style: normal;
text-decoration: underline;
}
.borg-common-opt-ref {
font-weight: bold;
}

4
docs/usage/benchmark_crud.rst.inc
View file

@ -14,8 +14,10 @@ PATH
path were to create benchmark input data
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/break-lock.rst.inc
View file

@ -12,8 +12,10 @@ REPOSITORY
repository for which to break the locks
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/change-passphrase.rst.inc
View file

@ -12,8 +12,10 @@ REPOSITORY
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/check.rst.inc
View file

@ -20,8 +20,10 @@ optional arguments
--save-space work slower, but using less space
.. class:: borg-common-opt-ref
:ref:`common_options`
|
filters
-P, --prefix only consider archive names starting with this prefix.

4
docs/usage/create.rst.inc
View file

@ -23,8 +23,10 @@ optional arguments
--no-cache-sync experimental: do not synchronize the cache. Implies --no-files-cache.
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Exclusion options
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN

4
docs/usage/delete.rst.inc
View file

@ -19,8 +19,10 @@ optional arguments
--save-space work slower, but using less space
.. class:: borg-common-opt-ref
:ref:`common_options`
|
filters
-P, --prefix only consider archive names starting with this prefix.

4
docs/usage/diff.rst.inc
View file

@ -22,8 +22,10 @@ optional arguments
--sort Sort the output lines by file path.
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Exclusion options
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN

4
docs/usage/export-tar.rst.inc
View file

@ -26,8 +26,10 @@ optional arguments
--strip-components NUMBER Remove the specified number of leading path elements. Pathnames with fewer elements will be silently skipped.
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/extract.rst.inc
View file

@ -27,8 +27,10 @@ optional arguments
--sparse create holes in output sparse file from all-zero chunks
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/info.rst.inc
View file

@ -16,8 +16,10 @@ optional arguments
--json format output as JSON
.. class:: borg-common-opt-ref
:ref:`common_options`
|
filters
-P, --prefix only consider archive names starting with this prefix.

4
docs/usage/init.rst.inc
View file

@ -18,8 +18,10 @@ optional arguments
--storage-quota Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

9
docs/usage/key.rst
View file

@ -1,8 +1,3 @@
.. include:: key_export.rst.inc
.. include:: key_import.rst.inc
.. _borg-change-passphrase:
.. include:: key_change-passphrase.rst.inc
@ -40,3 +35,7 @@ Fully automated using environment variables:
$ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change-passphrase repo
# now "new" is the current passphrase.
.. include:: key_export.rst.inc
.. include:: key_import.rst.inc

4
docs/usage/key_change-passphrase.rst.inc
View file

@ -12,8 +12,10 @@ REPOSITORY
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/key_export.rst.inc
View file

@ -19,8 +19,10 @@ optional arguments
--qr-html Create an html file suitable for printing and later type-in or qr scan
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/key_import.rst.inc
View file

@ -18,8 +18,10 @@ optional arguments
--paper interactively import from a backup done with ``--paper``
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/key_migrate-to-repokey.rst.inc
View file

@ -12,8 +12,10 @@ REPOSITORY
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/list.rst.inc
View file

@ -22,8 +22,10 @@ optional arguments
--json-lines Only valid for listing archive contents. Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
.. class:: borg-common-opt-ref
:ref:`common_options`
|
filters
-P, --prefix only consider archive names starting with this prefix.

4
docs/usage/mount.rst.inc
View file

@ -19,8 +19,10 @@ optional arguments
-o Extra mount options
.. class:: borg-common-opt-ref
:ref:`common_options`
|
filters
-P, --prefix only consider archive names starting with this prefix.

4
docs/usage/prune.rst.inc
View file

@ -28,8 +28,10 @@ optional arguments
--save-space work slower, but using less space
.. class:: borg-common-opt-ref
:ref:`common_options`
|
filters
-P, --prefix only consider archive names starting with this prefix.

4
docs/usage/recreate.rst.inc
View file

@ -21,8 +21,10 @@ optional arguments
-s, --stats print statistics at end
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Exclusion options
-e PATTERN, --exclude PATTERN exclude paths matching PATTERN

4
docs/usage/rename.rst.inc
View file

@ -14,8 +14,10 @@ NEWNAME
the new archive name to use
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/serve.rst.inc
View file

@ -17,8 +17,10 @@ optional arguments
--storage-quota Override storage quota of the repository (e.g. 5G, 1.5T). When a new repository is initialized, sets the storage quota on the new repository as well. Default: no quota.
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/umount.rst.inc
View file

@ -12,8 +12,10 @@ MOUNTPOINT
mountpoint of the filesystem to umount
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/upgrade.rst.inc
View file

@ -21,8 +21,10 @@ optional arguments
--disable-tam Disable manifest authentication (in key and cache)
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

4
docs/usage/with-lock.rst.inc
View file

@ -16,8 +16,10 @@ ARGS
command arguments
.. class:: borg-common-opt-ref
:ref:`common_options`
|
Description
~~~~~~~~~~~

3
setup.py
View file

@ -290,8 +290,7 @@ class build_usage(Command):
def write_options(self, parser, fp):
for group in parser._action_groups:
if group.title == 'Common options':
fp.write('\n\n:ref:`common_options`\n')
fp.write(' |')
fp.write('\n\n.. class:: borg-common-opt-ref\n\n:ref:`common_options`\n')
else:
self.write_options_group(group, fp)