[PATCH 1/2 resend] Documentation: user-manual: add information about "git help" at the beginning

From: Christian Couder <chriscool@tuxfamily.org>
Date: Nov 16, 2008, 17:10 UTC
Message-ID: <20081116181001.97c45196.chriscool@tuxfamily.org>

Talking about "git help" is useful because it has a few more features (like when using it without arguments or with "-a") and it may work on non unix like platforms.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 Documentation/user-manual.txt |   18 ++++++++++++++++--
 1 files changed, 16 insertions(+), 2 deletions(-)

	It seems that this patch and the following one have not
	been applyed.

	Here are some more detailed reasons why I think such a patch
	would be useful:

	- neither user-manual.txt nor gitutorial.txt talk, in their
	current state, about "git help",
	- there is a high probability that "man" does not work on
	Windows, though it seems that some work has been done for
	"git help" to work on this platform,
	- "git help" without argument and "git help -a" may be useful
	and have no "man" equivalent, "git help -w" (or "git help -i")
	may also be usefull/friendlier for some people,
	- it seems that "git help" also resolves git aliases,
	- some people still tell that git is not user friendly and
	even develop separate porcelains (like eg) to do a better job
	at helping newbies,
	- at GitTogether'08 many people seemed to agree that "git help"
	should be improved to have more newby friendly features,
	- I don't see the point of trying to improve "git help" any
	further if we don't make it more visible first.

	So, Junio, could you please tell me what is wrong with this patch?

	Thanks in advance,
	Christian.

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 645d752..48f7189 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -17,13 +17,27 @@ People needing to do actual development will also want to read
 
 Further chapters cover more specialized topics.
 
-Comprehensive reference documentation is available through the man
-pages.  For a command such as "git clone <repo>", just use
+Comprehensive reference documentation is available through either the
+linkgit:git-help[1] command or the man pages.  For a command such as
+"git clone <repo>", you can use:
+
+------------------------------------------------
+$ git help clone
+------------------------------------------------
+
+or:
 
 ------------------------------------------------
 $ man git-clone
 ------------------------------------------------
 
+linkgit:git-help[1] has a few more features and is self-documenting
+using:
+
+------------------------------------------------
+$ git help help
+------------------------------------------------
+
 See also <<git-quick-start>> for a brief overview of git commands,
 without any explanation.

-- 
1.6.0.4.617.g39d03