threads / patch / 16367

v2, 2 partsDocumentation: user-manual: add information about "git help" at the beginning

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

## tl;dr

One message between Nov 17, 2008 and Nov 17, 2008. Diffs are folded; open one to read it.

replies: 0people: 1as markdown or json

Christian Couder· Nov 17, 2008, 15:42 UTC · lore

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 |   12 +++++++++++-
 1 files changed, 11 insertions(+), 1 deletions(-)
	Here is a new version of this patch series with the changes
	from Junio.
	Thanks,
	Christian.
Show changes to Documentation/user-manual.txt +11 −1
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 645d752..c0d8caf 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -18,12 +18,22 @@ 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
+pages, or linkgit:git-help[1] command.  For example, for the command
+"git clone <repo>", you can either use:
 
 ------------------------------------------------
 $ man git-clone
 ------------------------------------------------
 
+or:
+
+------------------------------------------------
+$ git help clone
+------------------------------------------------
+
+With the latter, you can use the manual viewer of your choice; see
+linkgit:git-help[1] for more information.
+
 See also <<git-quick-start>> for a brief overview of git commands,
 without any explanation.
 
-- 
1.6.0.4.617.g621cb

← back to recent threads