mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-28 02:38:43 +00:00
Code Issues Releases Wiki Activity

docs: document good and problematic option placements, see #3356

Browse source 
(cherry picked from commit e3cb7c3c32)
This commit is contained in:
Thomas Waldmann 2017-11-25 19:46:48 +01:00
parent 938d122191
commit 21afd17f2f
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/usage_general.rst.inc
View file

@ -1,3 +1,20 @@
Positional Arguments and Options: Order matters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Borg only supports taking options (``-s`` and ``--progress`` in the example)
to the left or right of all positional arguments (``repo::archive`` and ``path``
in the example), but not in between them:
::
borg create -s --progress repo::archive path # good and preferred
borg create repo::archive path -s --progress # also works
borg create -s repo::archive path --progress # works, but ugly
borg create repo::archive -s --progress path # BAD
This is due to a problem in the argparse module: http://bugs.python.org/issue15112
Repository URLs Repository URLs
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~