commit 664e6a392ed0ace86e0182dc25bf365e8e34ed9d Author: teor <teor@torproject.org> Date: Thu Aug 29 22:52:21 2019 +1000 scripts/git: Improve usage documentation for merge-forward and push-all Part of 31314. --- scripts/git/git-merge-forward.sh | 12 ++++++++++++ scripts/git/git-push-all.sh | 25 +++++++++++++++++++------ 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/scripts/git/git-merge-forward.sh b/scripts/git/git-merge-forward.sh index a7e797eaf..b9591eaa7 100755 --- a/scripts/git/git-merge-forward.sh +++ b/scripts/git/git-merge-forward.sh @@ -1,5 +1,17 @@ #!/usr/bin/env bash +# Usage: git-merge-forward.sh -n -t <test-branch-prefix> -u +# arguments: +# -n: dry run mode +# -t: test branch mode: create new branches from the commits checked +# out in each maint directory. Call these branches prefix_029, +# prefix_035, ... , prefix_master. +# -u: in test branch mode, if a prefix_* branch exists, skip creating +# that branch. Use after a merge error, to restart the merge +# forward at the first unmerged branch. +# env vars: +# See the Configuration section for env vars and their default values. + ################# # Configuration # ################# diff --git a/scripts/git/git-push-all.sh b/scripts/git/git-push-all.sh index 8a8ef1f2d..0b3cfcd88 100755 --- a/scripts/git/git-push-all.sh +++ b/scripts/git/git-push-all.sh @@ -2,12 +2,25 @@ # Usage: git-push-all.sh -t <test-branch-prefix> -r <remote-name> -s # -- <git-opts> -# env vars: TOR_UPSTREAM_REMOTE_NAME=upstream TOR_PUSH_DELAY=0 -# git-opts: --no-atomic --dry-run (any other git push option) -# -# TOR_PUSH_DELAY pushes the master and maint branches separately, so that CI -# runs in a sensible order. -# push --atomic is the default when TOR_PUSH_DELAY=0, and for release branches. +# arguments: +# -t: test branch mode: Push test branches, rather than maint and +# release branches. Pushes the branches called prefix_029, +# prefix_035, ... , prefix_master. +# -r: push to remote-name, rather than $TOR_UPSTREAM_REMOTE_NAME. +# -s: push branches whose tips match upstream maint, release, or +# master branches. The default is to skip these branches. Use +# -s when testing for CI environment failures with old code. +# --: pass any other arguments to git, rather than the script. +# env vars: +# TOR_GIT_PUSH: the git push command and arguments +# TOR_UPSTREAM_REMOTE_NAME: the default upstream, overridden by -r +# TOR_PUSH_DELAY: pushes the master and maint branches separately, +# so that CI runs in a sensible order. +# TOR_PUSH_SAME: push branches whose tips match upstream maint, +# release, or master branches. Inverted by -s. +# See the Configuration section for env var default values. +# git-opts: +# --no-atomic --dry-run (and any other git push option) set -e