# [PATCH] Documentation: fix statement about rebase.instructionFormat

2 messages from 2024-01-03 to 2024-01-03. Participants: Maarten van der Schrieck via GitGitGadget, Junio C Hamano.
Thread: https://gitlist.dev/t/60681

## Maarten van der Schrieck via GitGitGadget, 2024-01-03 18:14

Subject: [PATCH] Documentation: fix statement about rebase.instructionFormat
Message-ID: <pull.1629.git.git.1704305663254.gitgitgadget@gmail.com>
URL: https://gitlist.dev/e/pull.1629.git.git.1704305663254.gitgitgadget%40gmail.com

```
From: Maarten van der Schrieck <maarten@thingsconnected.nl>

Since commit 62db5247790f2612c0b407a15d1901d88789d35a "rebase -i: generate
the script via rebase--helper" (Jul 14 2017), the short hash is given in
rebase-todo. Specifying rebase.instructionFormat does not alter this
behavior, contrary to what the documentation implies.

Signed-off-by: Maarten van der Schrieck <maarten@thingsconnected.nl>
---
    Documentation: fix statement about rebase.instructionFormat
    
    Since commit 62db5247790f2612c0b407a15d1901d88789d35a "rebase -i:
    generate the script via rebase--helper" (Jul 14 2017), the short hash is
    given in rebase-todo. Specifying rebase.instructionFormat does not alter
    this behavior, contrary to what the documentation implies.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1629%2Fthingsconnected%2Fpullreq1-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1629/thingsconnected/pullreq1-v1
Pull-Request: https://github.com/git/git/pull/1629

 Documentation/config/rebase.txt | 2 +-
 Documentation/git-rebase.txt    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/config/rebase.txt b/Documentation/config/rebase.txt
index d59576dbb23..c6187ab28b2 100644
--- a/Documentation/config/rebase.txt
+++ b/Documentation/config/rebase.txt
@@ -40,7 +40,7 @@ rebase.missingCommitsCheck::
 rebase.instructionFormat::
 	A format string, as specified in linkgit:git-log[1], to be used for the
 	todo list during an interactive rebase.  The format will
-	automatically have the long commit hash prepended to the format.
+	automatically have the commit hash prepended to the format.
 
 rebase.abbreviateCommands::
 	If set to true, `git rebase` will use abbreviated command names in the
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 1dd6555f66b..25516c45d8b 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -523,7 +523,7 @@ See also INCOMPATIBLE OPTIONS below.
 +
 The commit list format can be changed by setting the configuration option
 rebase.instructionFormat.  A customized instruction format will automatically
-have the long commit hash prepended to the format.
+have the commit hash prepended to the format.
 +
 See also INCOMPATIBLE OPTIONS below.
 

base-commit: 055bb6e9969085777b7fab83e3fee0017654f134
-- 
gitgitgadget

```

## Junio C Hamano, 2024-01-03 19:22

Subject: Re: [PATCH] Documentation: fix statement about rebase.instructionFormat
Message-ID: <xmqq1qay9q7g.fsf@gitster.g>
URL: https://gitlist.dev/e/xmqq1qay9q7g.fsf%40gitster.g
In-Reply-To: <pull.1629.git.git.1704305663254.gitgitgadget@gmail.com>

```
"Maarten van der Schrieck via GitGitGadget" <gitgitgadget@gmail.com>
writes:

> From: Maarten van der Schrieck <maarten@thingsconnected.nl>
>
> Since commit 62db5247790f2612c0b407a15d1901d88789d35a "rebase -i: generate
> the script via rebase--helper" (Jul 14 2017), the short hash is given in
> rebase-todo. Specifying rebase.instructionFormat does not alter this
> behavior, contrary to what the documentation implies.
>
> Signed-off-by: Maarten van der Schrieck <maarten@thingsconnected.nl>
> ---

Looks good.  Will queue.  Thanks.


>     Documentation: fix statement about rebase.instructionFormat
>     
>     Since commit 62db5247790f2612c0b407a15d1901d88789d35a "rebase -i:
>     generate the script via rebase--helper" (Jul 14 2017), the short hash is
>     given in rebase-todo. Specifying rebase.instructionFormat does not alter
>     this behavior, contrary to what the documentation implies.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1629%2Fthingsconnected%2Fpullreq1-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1629/thingsconnected/pullreq1-v1
> Pull-Request: https://github.com/git/git/pull/1629
>
>  Documentation/config/rebase.txt | 2 +-
>  Documentation/git-rebase.txt    | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/config/rebase.txt b/Documentation/config/rebase.txt
> index d59576dbb23..c6187ab28b2 100644
> --- a/Documentation/config/rebase.txt
> +++ b/Documentation/config/rebase.txt
> @@ -40,7 +40,7 @@ rebase.missingCommitsCheck::
>  rebase.instructionFormat::
>  	A format string, as specified in linkgit:git-log[1], to be used for the
>  	todo list during an interactive rebase.  The format will
> -	automatically have the long commit hash prepended to the format.
> +	automatically have the commit hash prepended to the format.
>  
>  rebase.abbreviateCommands::
>  	If set to true, `git rebase` will use abbreviated command names in the
> diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
> index 1dd6555f66b..25516c45d8b 100644
> --- a/Documentation/git-rebase.txt
> +++ b/Documentation/git-rebase.txt
> @@ -523,7 +523,7 @@ See also INCOMPATIBLE OPTIONS below.
>  +
>  The commit list format can be changed by setting the configuration option
>  rebase.instructionFormat.  A customized instruction format will automatically
> -have the long commit hash prepended to the format.
> +have the commit hash prepended to the format.
>  +
>  See also INCOMPATIBLE OPTIONS below.
>  
>
> base-commit: 055bb6e9969085777b7fab83e3fee0017654f134

```
