From e069b82bdbbae3a1da0c9e037483b2f0b7a6d4ed Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andrzej=20Ma=C5=82ota?=
 <86779115+amalota@users.noreply.github.com>
Date: Fri, 4 Nov 2022 14:55:56 +0100
Subject: [PATCH] Issue #711: Update docs with information that flag order
 defines their precedence over each other (#718)

---
 docs/enforce-docs-up-to-date.sh   | 2 +-
 docs/source/cli_help/traverse.rst | 4 ++++
 git_machete/generated_docs.py     | 4 ++++
 3 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/docs/enforce-docs-up-to-date.sh b/docs/enforce-docs-up-to-date.sh
index 967bb48da..a77a3de2b 100755
--- a/docs/enforce-docs-up-to-date.sh
+++ b/docs/enforce-docs-up-to-date.sh
@@ -6,6 +6,6 @@ current_docs=$(<git_machete/generated_docs.py)
 generated_docs=$(python docs/generate_py_docs.py)
 
 if [[ "$current_docs" != "$generated_docs" ]]; then
-  echo "Command line docs are not up-to-date. Please regenerate docs via tox -e py-docs"
+  echo "Command line docs are not up-to-date. Please regenerate docs via 'tox -e py-docs'"
   exit 1
 fi
diff --git a/docs/source/cli_help/traverse.rst b/docs/source/cli_help/traverse.rst
index 1f3d9a97c..2c18675bf 100644
--- a/docs/source/cli_help/traverse.rst
+++ b/docs/source/cli_help/traverse.rst
@@ -56,6 +56,10 @@ For each branch, the command:
 
       - prints the updated ``status``.
 
+By default ``traverse`` asks if the branch should be pushed, this behaviour can, however, be changed with the ``machete.traverse.push`` configuration key.
+It can also be customized using options: ``--[no-]push`` or ``--[no-]push-untracked`` --- the order of the flags defines their precedence over each other
+(the one on the right overriding the ones on the left). More on them in the **Options** section below.
+
 If the traverse flow is stopped (typically due to merge/rebase conflicts), just run ``git machete traverse`` after the merge/rebase is finished.
 It will pick up the walk from the current branch (unless ``--start-from=`` or ``-w`` etc. is passed).
 Unlike with e.g. ``git rebase``, there is no special ``--continue`` flag, as ``traverse`` is stateless
diff --git a/git_machete/generated_docs.py b/git_machete/generated_docs.py
index 5f3b89872..fc0bf265e 100644
--- a/git_machete/generated_docs.py
+++ b/git_machete/generated_docs.py
@@ -957,6 +957,10 @@
            * and finally, if any of the above operations has been successfully completed:
               - prints the updated `status`.
 
+        By default `traverse` asks if the branch should be pushed, this behaviour can, however, be changed with the `machete.traverse.push` configuration key.
+        It can also be customized using options: `--[no-]push` or `--[no-]push-untracked` — the order of the flags defines their precedence over each other
+        (the one on the right overriding the ones on the left). More on them in the <b>Options</b> section below.
+
         If the traverse flow is stopped (typically due to merge/rebase conflicts), just run `git machete traverse` after the merge/rebase is finished.
         It will pick up the walk from the current branch (unless `--start-from=` or `-w` etc. is passed).
         Unlike with e.g. `git rebase`, there is no special `--continue` flag, as `traverse` is stateless