git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 6/8] Doc add: link gitignore
@ 2012-09-16 10:58 Philip Oakley
  2012-09-17  5:50 ` Junio C Hamano
  0 siblings, 1 reply; 3+ messages in thread
From: Philip Oakley @ 2012-09-16 10:58 UTC (permalink / raw)
  To: gitList

Include the gitignore link with the paired gitrepository-
layout link.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---

without the gitignore link users are unlikely to realise the
significance of the repository layout link, nor what to look for
within it

diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 9c1d395..311be9a 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -155,7 +155,8 @@ Configuration
 The optional configuration variable `core.excludesfile` indicates a path to a
 file containing patterns of file names to exclude from git-add, similar to
 $GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to
-those in info/exclude.  See linkgit:gitrepository-layout[5].
+those in info/exclude.  See linkgit:gitrepository-layout[5] and
+linkgit:gitignore[5].
 
 
 EXAMPLES
-- 
1.7.8.msysgit.0

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH 6/8] Doc add: link gitignore
  2012-09-16 10:58 [PATCH 6/8] Doc add: link gitignore Philip Oakley
@ 2012-09-17  5:50 ` Junio C Hamano
  2012-09-17 22:01   ` Philip Oakley
  0 siblings, 1 reply; 3+ messages in thread
From: Junio C Hamano @ 2012-09-17  5:50 UTC (permalink / raw)
  To: Philip Oakley; +Cc: gitList

Philip Oakley <philipoakley@iee.org> writes:

> Include the gitignore link with the paired gitrepository-
> layout link.
>
> Signed-off-by: Philip Oakley <philipoakley@iee.org>
> ---
>
> without the gitignore link users are unlikely to realise the
> significance of the repository layout link, nor what to look for
> within it
>
> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
> index 9c1d395..311be9a 100644
> --- a/Documentation/git-add.txt
> +++ b/Documentation/git-add.txt
> @@ -155,7 +155,8 @@ Configuration
>  The optional configuration variable `core.excludesfile` indicates a path to a
>  file containing patterns of file names to exclude from git-add, similar to
>  $GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to
> -those in info/exclude.  See linkgit:gitrepository-layout[5].
> +those in info/exclude.  See linkgit:gitrepository-layout[5] and
> +linkgit:gitignore[5].

A reader of git-add shouldn't have to refer to gitrepository-layout[5]
in the first place when we talk about "add $pathspec" may ignore
paths that are configured to be ignored.  gitignore[5] should give
everything necessary to him.

This section (even before the precontext we can see in the patch)
may need a bit larger rewrite so that it just refers to gitignore[5]
and leave the details of where the exclude information comes to that
manual page.

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH 6/8] Doc add: link gitignore
  2012-09-17  5:50 ` Junio C Hamano
@ 2012-09-17 22:01   ` Philip Oakley
  0 siblings, 0 replies; 3+ messages in thread
From: Philip Oakley @ 2012-09-17 22:01 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: gitList

From: "Junio C Hamano" <gitster@pobox.com>
> Philip Oakley <philipoakley@iee.org> writes:
>
>> Include the gitignore link with the paired gitrepository-
>> layout link.
>>
>> Signed-off-by: Philip Oakley <philipoakley@iee.org>
>> ---
>>
>> without the gitignore link users are unlikely to realise the
>> significance of the repository layout link, nor what to look for
>> within it
>>
>> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
>> index 9c1d395..311be9a 100644
>> --- a/Documentation/git-add.txt
>> +++ b/Documentation/git-add.txt
>> @@ -155,7 +155,8 @@ Configuration
>>  The optional configuration variable `core.excludesfile` indicates a 
>> path to a
>>  file containing patterns of file names to exclude from git-add, 
>> similar to
>>  $GIT_DIR/info/exclude.  Patterns in the exclude file are used in 
>> addition to
>> -those in info/exclude.  See linkgit:gitrepository-layout[5].
>> +those in info/exclude.  See linkgit:gitrepository-layout[5] and
>> +linkgit:gitignore[5].
>
> A reader of git-add shouldn't have to refer to gitrepository-layout[5]
> in the first place when we talk about "add $pathspec" may ignore
> paths that are configured to be ignored.  gitignore[5] should give
> everything necessary to him.

True. Now that 5/8 makes the details in gitignore clearer it should be 
OK to change from linking repository layout to the gitignor page.
>
> This section (even before the precontext we can see in the patch)
> may need a bit larger rewrite so that it just refers to gitignore[5]
> and leave the details of where the exclude information comes to that
> manual page.

I'll see if I can do something on that as a separate patch.

Philip 

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2012-09-17 22:01 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-09-16 10:58 [PATCH 6/8] Doc add: link gitignore Philip Oakley
2012-09-17  5:50 ` Junio C Hamano
2012-09-17 22:01   ` Philip Oakley

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).