[2/3] Update management documentation
diff mbox series

Message ID 20190715145030.7877-2-metepolat2000@gmail.com
State New
Headers show
Series
  • [1/3] Add export project as mbox management command
Related show

Commit Message

Mete Polat July 15, 2019, 2:50 p.m. UTC
Signed-off-by: Mete Polat <metepolat2000@gmail.com>
---
 docs/deployment/management.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

Patch
diff mbox series

diff --git a/docs/deployment/management.rst b/docs/deployment/management.rst
index c50b7b6..70e926c 100644
--- a/docs/deployment/management.rst
+++ b/docs/deployment/management.rst
@@ -133,3 +133,31 @@  patches for these new tags.
 .. option:: patch_id
 
    a patch ID number. If not supplied, all patches will be updated.
+
+exportproject
+~~~~~~~~~~~~~
+
+.. program:: manage.py exportproject
+
+Export patchwork projects as mbox files and optionally compress the result.
+
+.. code-block:: shell
+
+  ./manage.py exportproject [-c | --compress] [-l | --level] [<project_linkname>...]
+
+This is mostly useful for importing the patch dataset of a Patchwork project
+into other programs.
+
+.. option:: -c, --compress
+
+   Bundle given projects into a gzip compressed tar archive. If --level is 0,
+   bundle the given projects into a tar archive without compression.
+
+.. option:: -l, --level
+
+    compression level. A value between 0 and 9 (default). 0 is no compression.
+    Ignored if --compression is not set.
+
+.. option:: project_link
+
+    a project linkname. If not supplied, all projects will be exported.