diff mbox series

Documentation/howto/maintain-git.txt: fix Meta/redo-jch.sh invocation

Message ID 4ba057094ae6b1bd5c18583f23f7f99232034c72.1666815325.git.me@ttaylorr.com (mailing list archive)
State New, archived
Headers show
Series Documentation/howto/maintain-git.txt: fix Meta/redo-jch.sh invocation | expand

Commit Message

Taylor Blau Oct. 26, 2022, 8:15 p.m. UTC
The Meta/redo-jch.sh script is generated a few lines earlier by running:

    $ Meta/Reintegrate master..seen >Meta/redo-jch.sh

But the resulting script is not necessarily executable. Later mentions
of this script invoke it with sh (instead of directly), but this one is
an odd one out.

Update the documentation to invoke the Meta/redo-jch.sh script with sh
in case the maintainer has not made the script executable.

Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
Noticed while reading and following along with
Documentation/howto/maintain-git.txt.

 Documentation/howto/maintain-git.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.38.0.16.g393fd4c6db

Comments

Junio C Hamano Oct. 26, 2022, 8:35 p.m. UTC | #1
Taylor Blau <me@ttaylorr.com> writes:

> The Meta/redo-jch.sh script is generated a few lines earlier by running:
>
>     $ Meta/Reintegrate master..seen >Meta/redo-jch.sh
>
> But the resulting script is not necessarily executable. Later mentions
> of this script invoke it with sh (instead of directly), but this one is
> an odd one out.
>
> Update the documentation to invoke the Meta/redo-jch.sh script with sh
> in case the maintainer has not made the script executable.
>
> Signed-off-by: Taylor Blau <me@ttaylorr.com>
> ---
> Noticed while reading and following along with
> Documentation/howto/maintain-git.txt.

OK.  In the real life, the script gets once "chmod +x" and kept
updated by running "Meta/redo-jch.sh -u" which would update the
script in place, preserving the executable bit.  But explicitly
running it with the shell is less magical and less error-prone.


>  Documentation/howto/maintain-git.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/howto/maintain-git.txt b/Documentation/howto/maintain-git.txt
> index a67130debb..215e2edb0f 100644
> --- a/Documentation/howto/maintain-git.txt
> +++ b/Documentation/howto/maintain-git.txt
> @@ -256,7 +256,7 @@ by doing the following:
>     merged to 'next', add it at the end of the list.  Then:
>
>       $ git checkout -B jch master
> -     $ Meta/redo-jch.sh -c1
> +     $ sh Meta/redo-jch.sh -c1
>
>     to rebuild the 'jch' branch from scratch.  "-c1" tells the script
>     to stop merging at the first line that begins with '###'
> --
> 2.38.0.16.g393fd4c6db
diff mbox series

Patch

diff --git a/Documentation/howto/maintain-git.txt b/Documentation/howto/maintain-git.txt
index a67130debb..215e2edb0f 100644
--- a/Documentation/howto/maintain-git.txt
+++ b/Documentation/howto/maintain-git.txt
@@ -256,7 +256,7 @@  by doing the following:
    merged to 'next', add it at the end of the list.  Then:

      $ git checkout -B jch master
-     $ Meta/redo-jch.sh -c1
+     $ sh Meta/redo-jch.sh -c1

    to rebuild the 'jch' branch from scratch.  "-c1" tells the script
    to stop merging at the first line that begins with '###'