git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Philip Oakley <philipoakley@iee.org>
Date
Sep 17, 2012, 22:01 UTC
Message-ID
<6AB419E032004F8A890B01EC04731CD2@PhilipOakley>
In-Reply-To
<7vhaqxw635.fsf@alter.siamese.dyndns.org>
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 
Previous: Junio C Hamano
Message 3 of 3 in “Doc add: link gitignore”
  1. 6/8 Doc add: link gitignorePhilip Oakley, Sep 16, 2012
  2. Junio C HamanoSep 17, 2012
  3. Philip OakleySep 17, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.