From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Shao-Ce SUN via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Shao-Ce SUN <sunshaoce@iscas.ac.cn>
Subject: Re: [PATCH] Fix wrong info in `INSTALL`
Date: Tue, 24 May 2022 23:39:31 +0200 [thread overview]
Message-ID: <220524.86a6b6vcao.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <pull.1241.git.1653424998869.gitgitgadget@gmail.com>
On Tue, May 24 2022, Shao-Ce SUN via GitGitGadget wrote:
> From: Shao-Ce SUN <sunshaoce@iscas.ac.cn>
>
> The user prompt should be `$` instead of `#`.
>
> Signed-off-by: Shao-Ce SUN <sunshaoce@iscas.ac.cn>
> ---
> Fix wrong info in INSTALL
>
> The user prompt should be $ instead of #.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1241%2Fsunshaoce%2Finstall-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1241/sunshaoce/install-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/1241
>
> INSTALL | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> diff --git a/INSTALL b/INSTALL
> index 4140a3f5c8b..7bb3f48311d 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -5,8 +5,8 @@ Normally you can just do "make" followed by "make install", and that
> will install the git programs in your own ~/bin/ directory. If you want
> to do a global install, you can do
>
> - $ make prefix=/usr all doc info ;# as yourself
> - # make prefix=/usr install install-doc install-html install-info ;# as root
> + $ make prefix=/usr all doc info ; $ as yourself
> + # make prefix=/usr install install-doc install-html install-info ; # as root
>
> (or prefix=/usr/local, of course). Just like any program suite
> that uses $prefix, the built results have some paths encoded,
> @@ -20,10 +20,10 @@ config.mak file.
> Alternatively you can use autoconf generated ./configure script to
> set up install paths (via config.mak.autogen), so you can write instead
>
> - $ make configure ;# as yourself
> - $ ./configure --prefix=/usr ;# as yourself
> - $ make all doc ;# as yourself
> - # make install install-doc install-html;# as root
> + $ make configure ; $ as yourself
> + $ ./configure --prefix=/usr ; $ as yourself
> + $ make all doc ; $ as yourself
> + # make install install-doc install-html; # as root
>
> If you're willing to trade off (much) longer build time for a later
> faster git you can also do a profile feedback build with
>
> base-commit: 7a3eb286977746bc09a5de7682df0e5a7085e17c
This looks good to me, FWIW I dug into this slightly and didn't know
that POSIX had this to say about it:
This variable is used for interactive prompts. Historically, the
"superuser" has had a prompt of '#'. Since privileges are not
required to be monolithic, it is difficult to define which
privileges should cause the alternate prompt. However, a
sufficiently powerful user should be reminded of that power by
having an alternate prompt.
See https://pubs.opengroup.org/onlinepubs/9699919799/xrat/V4_xcu_chap02.html#tag_23_02_05_03
The one suggestion I have here is that the $subject should be clearer, e.g.:
INSTALL: use '#', not '$' for root-run command prompt
Which in this case would both be better in --oneline output, and be
enough to get rid of the commit message body entirely (unless it wished
to say something more on the subject).
next prev parent reply other threads:[~2022-05-24 21:41 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-24 20:43 [PATCH] Fix wrong info in `INSTALL` Shao-Ce SUN via GitGitGadget
2022-05-24 21:39 ` Ævar Arnfjörð Bjarmason [this message]
2022-05-24 22:03 ` Philippe Blain
2022-05-24 22:21 ` Junio C Hamano
2022-05-25 5:29 ` Christian Couder
2022-05-25 16:05 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=220524.86a6b6vcao.gmgdl@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=sunshaoce@iscas.ac.cn \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).