threads / patch / 31553

patch, 8 partsDoc add: link gitignore

Subject: [PATCH 6/8] Doc add: link gitignore

## tl;dr

3 messages between Sep 16, 2012 and Sep 17, 2012. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Philip Oakley· Sep 16, 2012, 10:58 UTC · lore

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

Show changes to Documentation/git-add.txt +2 −1

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

Junio C Hamano· Sep 17, 2012, 05:50 UTC · re: Philip Oakley · lore

Re: [PATCH 6/8] Doc add: link gitignore

Philip Oakley <philipoakley@iee.org> writes:

Show 21 quoted lines

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

Philip Oakley· Sep 17, 2012, 22:01 UTC · re: Junio C Hamano · lore

Re: [PATCH 6/8] Doc add: link gitignore

From: "Junio C Hamano" <gitster@pobox.com>

Show 31 quoted lines

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

Show 5 quoted lines

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