diff mbox series

INSTALL: use existing shell scripts as example

Message ID 20191114173316.9190-1-rybak.a.v@gmail.com (mailing list archive)
State New, archived
Headers show
Series INSTALL: use existing shell scripts as example | expand

Commit Message

Andrei Rybak Nov. 14, 2019, 5:33 p.m. UTC
Script git-pull.sh has been removed in commit [1].  Use command
"request-pull" as an example of a shell script instead.  Recently, many
of shell script commands have been re-written in C, so tweak the wording
of the sentence, while we're here.

[1]: b1456605c2 (pull: remove redirection to git-pull.sh, 2015-06-18)

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
---
 INSTALL | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Junio C Hamano Nov. 15, 2019, 5:56 a.m. UTC | #1
Andrei Rybak <rybak.a.v@gmail.com> writes:

> Script git-pull.sh has been removed in commit [1].  Use command
> "request-pull" as an example of a shell script instead.  Recently, many
> of shell script commands have been re-written in C, so tweak the wording
> of the sentence, while we're here.
>
> [1]: b1456605c2 (pull: remove redirection to git-pull.sh, 2015-06-18)
>
> Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
> ---
>  INSTALL | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/INSTALL b/INSTALL
> index c39006e8e7..e3170b3cee 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -116,8 +116,8 @@ Issues of note:
>  
>  	- "ssh" is used to push and pull over the net.
>  
> -	- A POSIX-compliant shell is required to run many scripts needed
> -	  for everyday use (e.g. "bisect", "pull").
> +	- A POSIX-compliant shell is required to run some scripts needed
> +	  for everyday use (e.g. "bisect", "request-pull").

This is not wrong per-se and does improve the section locally (i.e. "pull"
was a bad example of scripts needed for everyday use).

But in the longer term, I am not sure if we want to keep giving
examples in the first place---this sentence will require constant
rewriting.

Admittedly, this "Git is reasonably self-sufficient, but does
depend" section itself is an oddball to list the requirements by the
final product.  We may want to eject the section (not just this
sentence) from INSTALL file altogether, as otherwise, the document
itself is meant for those who build and install git from the source,
and when you are building from the source, you do need a shell
anyway.

Thanks, will queue.
diff mbox series

Patch

diff --git a/INSTALL b/INSTALL
index c39006e8e7..e3170b3cee 100644
--- a/INSTALL
+++ b/INSTALL
@@ -116,8 +116,8 @@  Issues of note:
 
 	- "ssh" is used to push and pull over the net.
 
-	- A POSIX-compliant shell is required to run many scripts needed
-	  for everyday use (e.g. "bisect", "pull").
+	- A POSIX-compliant shell is required to run some scripts needed
+	  for everyday use (e.g. "bisect", "request-pull").
 
 	- "Perl" version 5.8 or later is needed to use some of the
 	  features (e.g. preparing a partial commit using "git add -i/-p",