[PATCH 2/3] Documentation: user-manual: add information about "git help" at the beginning
- From
Christian Couder <chriscool@tuxfamily.org>
- Date
- Nov 14, 2008, 12:27 UTC
- Message-ID
- <20081114132705.5bb9be21.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(-)
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.g621cb