From 26a78463f1afa653cd420436f2984ce636eb0b29 Mon Sep 17 00:00:00 2001 From: Alexander Graf <17130992+aandergr@users.noreply.github.com> Date: Wed, 3 Jun 2020 18:03:27 +0200 Subject: [PATCH] doc: Discourage using --commit-mode --commit-mode has many bugs, especially #257, #483. For now we discourage using it until it is reimplemented. --- docs/cli-options.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/cli-options.rst b/docs/cli-options.rst index 2eb4edb..dac3568 100644 --- 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.