Parcourir la source

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

Thomas Waldmann il y a 7 ans
Parent
commit
8db5d1ba90
1 fichiers modifiés avec 17 ajouts et 0 suppressions
  1. 17 0
      docs/usage.rst

+ 17 - 0
docs/usage.rst

@@ -12,6 +12,23 @@ command in detail.
 General
 General
 -------
 -------
 
 
+Positional Arguments and Options: Order matters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Borg only supports taking options (``-v`` and ``--list`` 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 extract -v --list repo::archive path  # good and preferred
+    borg extract repo::archive path -v --list  # also works
+    borg extract -v repo::archive path --list  # works, but ugly
+    borg extract repo::archive -v --list path  # BAD
+
+This is due to a problem in the argparse module: http://bugs.python.org/issue15112
+
+
 Repository URLs
 Repository URLs
 ~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~