git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Philip Oakley <philipoakley@iee.org>
Cc: gitList <git@vger.kernel.org>
Subject: Re: [PATCHv2 4/8] Doc: 'git' has a discussion section
Date: Tue, 18 Sep 2012 20:50:36 -0700	[thread overview]
Message-ID: <7vr4pyisc3.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1348010734-664-5-git-send-email-philipoakley@iee.org> (Philip Oakley's message of "Wed, 19 Sep 2012 00:25:30 +0100")

Philip Oakley <philipoakley@iee.org> writes:

> Highlight there is a further discussion section later in
> git man page
>
> Signed-off-by: Philip Oakley <philipoakley@iee.org>
>
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 34d8a1b..d932a3e 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -30,6 +30,7 @@ After you mastered the basic concepts, you can come back to this
>  page to learn what commands git offers.  You can learn more about
>  individual git commands with "git help command".  linkgit:gitcli[7]
>  manual page gives you an overview of the command line command syntax.
> +See also the Discussion and Further Documentation sections below.
>  
>  Formatted and hyperlinked version of the latest git documentation
>  can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.

I am not sure if this is appropriate.

The primary objective of this paragraph is to nudge people who try
to dive into the body of this document without understanding the
fundamentals (which tends to waste their time) without spending too
many words.  After they visit these pages, they are armed with
sufficient prerequisite knowledge and are free to go directly to
documentation for individual subcommands, and this page is one of
such pages.  I do not think Discussion and Further Documentation
sections are such prerequisites they should read before coming back
here and looking at the list of subcommands.

  reply	other threads:[~2012-09-19  3:50 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-09-18 23:25 [PATCHv2 4/8] Doc: 'git' has a discussion section Philip Oakley
2012-09-19  3:50 ` Junio C Hamano [this message]
2012-09-19  7:19   ` Philip Oakley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7vr4pyisc3.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=philipoakley@iee.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).