Git development
 help / color / mirror / Atom feed
From: "Philip Oakley" <philipoakley@iee.org>
To: "Junio C Hamano" <gitster@pobox.com>
Cc: "gitList" <git@vger.kernel.org>
Subject: Re: [PATCHv2 4/8] Doc: 'git' has a discussion section
Date: Wed, 19 Sep 2012 08:19:16 +0100	[thread overview]
Message-ID: <A2353F0975764FD3A89690A64FBC8694@PhilipOakley> (raw)
In-Reply-To: 7vr4pyisc3.fsf@alter.siamese.dyndns.org

From: "Junio C Hamano" <gitster@pobox.com>
> 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.
>
It was more that _all_ man pages link back here, and these (hopefully 
useful ;-)  Discussion and Further Documentation sections are waaay off 
the bottom of the screen, so are easy to never see.

Actually I would have liked to make it an active link to the section for 
any html version, but wasn't sure how to achieve that - is there a 
method to link within a document?

Philip

      reply	other threads:[~2012-09-19  7:19 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
2012-09-19  7:19   ` Philip Oakley [this message]

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=A2353F0975764FD3A89690A64FBC8694@PhilipOakley \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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