Просмотр исходного кода

docs: extract: move cwd note to --help

Marian Beermann 8 лет назад
Родитель
Сommit
771168a3af
2 измененных файлов с 5 добавлено и 6 удалено
  1. 0 6
      docs/usage/extract.rst
  2. 5 0
      src/borg/archiver.py

+ 0 - 6
docs/usage/extract.rst

@@ -21,9 +21,3 @@ Examples
 
     # Restore a raw device (must not be active/in use/mounted at that time)
     $ borg extract --stdout /path/to/repo::my-sdx | dd of=/dev/sdx bs=10M
-
-
-.. Note::
-
-    Currently, extract always writes into the current working directory ("."),
-    so make sure you ``cd`` to the right place before calling ``borg extract``.

+ 5 - 0
src/borg/archiver.py

@@ -2893,6 +2893,11 @@ class Archiver:
 
         ``--progress`` can be slower than no progress display, since it makes one additional
         pass over the archive metadata.
+
+        .. note::
+
+            Currently, extract always writes into the current working directory ("."),
+            so make sure you ``cd`` to the right place before calling ``borg extract``.
         """)
         subparser = subparsers.add_parser('extract', parents=[common_parser], add_help=False,
                                           description=self.do_extract.__doc__,