[PATCH 2/2] Documentation: make git-sh-setup docs less scary
From: Thomas Rast <hidden>
Date: 2016-06-15 22:52:40
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
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 <redacted> --- 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