Re: [PATCH] Provide a 'git help user-manual' route to the docbook
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Feb 18, 2014, 20:14 UTC
- Message-ID
- <xmqqha7wdvpz.fsf@gitster.dls.corp.google.com>
- In-Reply-To
- <1392472299-3780-2-git-send-email-philipoakley@iee.org>
Philip Oakley <philipoakley@iee.org> writes:
Show 20 quoted lines
> diff --git a/Documentation/gituser-manual.txt b/Documentation/gituser-manual.txt > new file mode 100644 > index 0000000..9fd4744 > --- /dev/null > +++ b/Documentation/gituser-manual.txt > @@ -0,0 +1,34 @@ > +gituser-manual(7) > +================= > + > +NAME > +---- > +gituser-manual - a link to the user-manual docbook > + > + > +SYNOPSIS > +-------- > +[verse] > +'git help user-manual' > + > +link:user-manual.html[Git User's Manual]
Is it just me, or is typing
$ git help user-manual
and not seeing the manual itself, but only a link you have to click to get there a worthwhile addition?
I would not mind having a clickable link in the output from
$ git help git
or something that does already have other useful information, though.
Show 31 quoted lines
> +
> +DESCRIPTION
> +-----------
> +Git is a fast, scalable, distributed revision control system with an
> +unusually rich command set that provides both high-level operations
> +and full access to internals.
> +
> +The link:user-manual.html[Git User's Manual] provides an
> +in-depth introduction to Git.
> +
> +SEE ALSO
> +--------
> +linkgit:gittutorial[7],
> +linkgit:giteveryday[7],
> +linkgit:gitcli[7],
> +linkgit:gitworkflows[7]
> +
> +GIT
> +---
> +Part of the linkgit:git[1] suite
> diff --git a/builtin/help.c b/builtin/help.c
> index 1fdefeb..be7c39d 100644
> --- a/builtin/help.c
> +++ b/builtin/help.c
> @@ -427,6 +427,7 @@ static struct {
> { "modules", N_("Defining submodule properties") },
> { "revisions", N_("Specifying revisions and ranges for Git") },
> { "tutorial", N_("A tutorial introduction to Git (for version 1.5.1 or newer)") },
> + { "user-manual", N_("A link to the user-manual docbook") },
> { "workflows", N_("An overview of recommended workflows with Git") },
> };