[PATCH] Announce: unset GIT_PAGER and add minimal usage in header

From: Stefan Beller <sbeller@google.com>
Date: May 30, 2018, 23:27 UTC
Message-ID: <20180530232750.10432-1-sbeller@google.com>

When running the Announce script in a terminal, the git shortlog will open a pager, which is confusing as it leads to omission of the rest of the message inside the pager. Do not page the output to avoid confusion.

While at it, add a basic usage example to the header, which illustrates how it is used. This might be useful, but the way branch and previous are set already help a lot.

Signed-off-by: Stefan Beller <sbeller@google.com>
---

This applies to the todo branch. Not sure if it is worth it, though.

I played around with the Announce script after I realized that the announcement emails are not checked in, but generated on the fly. The reason I played around with the script is the two seemingly same points

Show 7 quoted lines

>  * Rename detection logic in "diff" family that is used in "merge" has
>    learned to guess when all of x/a, x/b and x/c have moved to z/a,
>    z/b and z/c, it is likely that x/d added in the meantime would also
>    want to move to z/d by taking the hint that the entire directory
>    'x' moved to 'z'.  A bug causing dirty files involved in a rename
>    to be overwritten during merge has also been fixed as part of this
>    work.

The second time it appears, it also contains:

>           Incidentally, this also avoids updating a file in the
>    working tree after a (non-trivial) merge whose result matches what
>    our side originally had.

which made me wonder how this message comes to life.

Thanks, Stefan

 Announce | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Announce b/Announce
index 91d0ba44cca..7c573e2fc40 100755
--- a/Announce
+++ b/Announce
@@ -1,11 +1,16 @@
 #!/bin/sh
 # Announcement message skelton
+# usage: Meta/Announce <version to announce> <diff-against>
+# e.g. Meta/Announce v2.18.0-rc0 v2.17.0
 #
+
 tmpbase=/var/tmp/git-announce.$$
 trap 'rm -f $tmpbase.*' 0
 branch=${1?branch}
 previous=${2?previous}
 commit=${3-"$1"}
+GIT_PAGER=
+export GIT_PAGER
 
 relname=$(git describe "$commit") &&
 vername=$(expr "$relname" : 'v\(.*\)') || exit $?

-- 
2.17.0.582.gccdcbd54c44.dirty