pre-rebase hook: capture documentation in a <<here document

From: Stefan Beller <sbeller@google.com>
Date: Jul 10, 2017, 23:35 UTC
Message-ID: <20170710233525.11650-1-sbeller@google.com>

From: Jonathan Nieder <jrnieder@gmail.com>

Without this change, the sample hook does not pass a syntax check (sh -n):

  $ sh -n hooks--pre-rebase.sample
  hooks--pre-rebase.sample: line 101: syntax error near unexpected token `('
  hooks--pre-rebase.sample: line 101: `   merged into it again (either directly or indirectly).'

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Improved-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
---

Junio wrote in "What's-cooking":

Show 6 quoted lines

> ... I do not know how well they are tested
> in the field by people using 'master' in their everyday workflow.
> Ideally, our release process wants to see more people using 'next'
> in their everyday workflow to keep 'master' more stable than any
> tagged release, but I do not have a good idea on how to encourage
> it more than we currently do.

Our internal release of git @ Google is debian experimental, which is basically the 'next' branch + this patch + another patch.

AFAICT It is a resend of https://public-inbox.org/git/20120308122105.GA1562@burratino/

As Jonathan is a Debian Developer, it is easy for us to base our internal version onto debian experimental, but long term we may want to base our internal version on the original next. :) To do so, upstream this one last meaningful patch.

The 'another patch' from above is changing and hardcoding the version number, which we do not want to upstream.

Thanks, Stefan

 templates/hooks--pre-rebase.sample | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/templates/hooks--pre-rebase.sample b/templates/hooks--pre-rebase.sample
index 053f111..b7f81c1 100755
--- a/templates/hooks--pre-rebase.sample
+++ b/templates/hooks--pre-rebase.sample
@@ -88,9 +88,7 @@ else
 	exit 1
 fi
 
-exit 0
-
-################################################################
+<<\DOC_END
 
 This sample hook safeguards topic branches that have been
 published from being rewound.
@@ -167,3 +165,5 @@ To compute (2):
 	git rev-list master..topic
 
 	if this is empty, it is fully merged to "master".
+
+DOC_END

-- 
1.8.5.3