# [PATCHv2 4/8] Doc: 'git' has a discussion section 3 messages from 2012-09-18 to 2012-09-19. Participants: Philip Oakley, Junio C Hamano. Thread: https://gitlist.dev/t/31593 ## Philip Oakley, 2012-09-18 23:25 Subject: [PATCHv2 4/8] Doc: 'git' has a discussion section Message-ID: <1348010734-664-5-git-send-email-philipoakley@iee.org> URL: https://gitlist.dev/e/1348010734-664-5-git-send-email-philipoakley%40iee.org ``` Highlight there is a further discussion section later in git man page Signed-off-by: Philip Oakley 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`. -- 1.7.8.msysgit.0 ``` ## Junio C Hamano, 2012-09-19 03:50 Subject: Re: [PATCHv2 4/8] Doc: 'git' has a discussion section Message-ID: <7vr4pyisc3.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vr4pyisc3.fsf%40alter.siamese.dyndns.org In-Reply-To: <1348010734-664-5-git-send-email-philipoakley@iee.org> ``` Philip Oakley writes: > Highlight there is a further discussion section later in > git man page > > Signed-off-by: Philip Oakley > > 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. ``` ## Philip Oakley, 2012-09-19 07:19 Subject: Re: [PATCHv2 4/8] Doc: 'git' has a discussion section Message-ID: URL: https://gitlist.dev/e/A2353F0975764FD3A89690A64FBC8694%40PhilipOakley In-Reply-To: <7vr4pyisc3.fsf@alter.siamese.dyndns.org> ``` From: "Junio C Hamano" > Philip Oakley writes: > >> Highlight there is a further discussion section later in >> git man page >> >> Signed-off-by: Philip Oakley >> >> 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 ```