From: Thomas Rast <trast@student.ethz.ch>
To: <git@vger.kernel.org>
Subject: [PATCH 2/2] Documentation: make git-sh-setup docs less scary
Date: Tue, 20 Dec 2011 12:09:05 +0100 [thread overview]
Message-ID: <c8867738c264a76f9662080b64e00615ec1aa28f.1324378986.git.trast@student.ethz.ch> (raw)
In-Reply-To: <c53feb0de8006c205fd26c2c07dcd78bd86b6c24.1324378986.git.trast@student.ethz.ch>
At least one IRC user was scared away by the introductory "This is not
a command the end user would want to run. Ever." to the point of not
reading on.
Reword it in a more matter-of-fact way that does not intentionally try
to scare the user away. Since 46bac90 (Do not install shell libraries
executable, 2010-01-31) it is not executable anyway, so the end user
would get
$ git sh-setup
fatal: cannot exec 'git-sh-setup': Permission denied
Signed-off-by: Thomas Rast <trast@student.ethz.ch>
---
Documentation/git-sh-setup.txt | 11 ++++-------
1 files changed, 4 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index bbfefca..612fb50 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -13,13 +13,10 @@ SYNOPSIS
DESCRIPTION
-----------
-This is not a command the end user would want to run. Ever.
-This documentation is meant for people who are studying the
-Porcelain-ish scripts and/or are writing new ones.
-
-The 'git sh-setup' scriptlet is designed to be sourced (using
-`.`) by other shell scripts to set up some variables pointing at
-the normal git directories and a few helper shell functions.
+This command cannot be run by the end user. Shell scripts can
+source it (using `.` as indicated above) to set up some variables
+pointing at the normal git directories and a few helper shell
+functions.
Before sourcing it, your script should set up a few variables;
`USAGE` (and `LONG_USAGE`, if any) is used to define message
--
1.7.8.484.gdad4270
next prev parent reply other threads:[~2011-12-20 11:09 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-12-20 11:09 [PATCH 1/2] git-sh-setup: make require_clean_work_tree part of the interface Thomas Rast
2011-12-20 11:09 ` Thomas Rast [this message]
2011-12-20 19:20 ` [PATCH 2/2] Documentation: make git-sh-setup docs less scary Junio C Hamano
2011-12-20 19:45 ` Ævar Arnfjörð Bjarmason
2011-12-20 20:27 ` Thomas Rast
2011-12-20 19:25 ` [PATCH 1/2] git-sh-setup: make require_clean_work_tree part of the interface Junio C Hamano
2011-12-20 20:29 ` [PATCH v2] " Thomas Rast
2011-12-20 20:52 ` Junio C Hamano
2011-12-20 21:42 ` [PATCH v3] " Thomas Rast
2011-12-20 22: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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c8867738c264a76f9662080b64e00615ec1aa28f.1324378986.git.trast@student.ethz.ch \
--to=trast@student.ethz.ch \
--cc=git@vger.kernel.org \
/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.
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 NNTP newsgroup(s).