doc: Discourage using --commit-mode

--commit-mode has many bugs, especially #257, #483. For now we discourage using it until it is reimplemented.
2020-06-03 18:03:27 +02:00 · 2020-06-03 18:03:27 +02:00 · 26a78463f1
commit 26a78463f1
parent 689dd3613b
1 changed files with 5 additions and 0 deletions
--- a/docs/cli-options.rst
+++ b/docs/cli-options.rst
@ -243,6 +243,11 @@ How to Download

   .. versionadded:: 4.2

+   .. warning::
+      We discourage from using the "commit mode" due to its bugs when being used
+      with other command line options (e.g. :issue:`257` with
+      :option:`--fast-update` and :issue:`483` with :option:`--tagged`).
+
 .. option:: --request-timeout N

   Seconds to wait before timing out a connection request.