Re: [RFC PATCH 2/6] Add bit on extending git to Hacking Git

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




> On May 17, 2020, at 2:34 PM, Junio C Hamano <gitster@xxxxxxxxx> wrote:
> 
> Kenneth Lorber <keni@xxxxxxxx> writes:
> 
>> From: Kenneth Lorber <keni@xxxxxxx>
>> 
>> The Hacking Git section of the user manual is the logical place to look
>> for information on extending Gut, so add a short section of links to
>> places where that information actually lives.
>> 
>> Signed-off-by: Kenneth Lorber <keni@xxxxxxx>
>> ---
>> Documentation/user-manual.txt | 8 ++++++++
>> 1 file changed, 8 insertions(+)
>> 
>> diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
>> index 833652983f..2144246444 100644
>> --- a/Documentation/user-manual.txt
>> +++ b/Documentation/user-manual.txt
>> @@ -4049,6 +4049,14 @@ and that is what higher level `git merge -s resolve` is implemented with.
>> This chapter covers internal details of the Git implementation which
>> probably only Git developers need to understand.
>> 
>> +If you are extending Git using hooks, writing new tools, or otherwise
>> +looking for technical information but not hacking Git itself, the following
>> +documents may be what you are really looking for:
>> +
>> +* hooks: linkgit:githooks[5]
>> +* attributes: linkgit:gitattributes[5]
>> +* new tools: linkgit:git-sh-setup[1]
> 
> I am not sure if this fits here.  It is a distraction to the target
> audience of this section, no?

I agree and still think this is where it goes (unless we start a new chapter on hacking FOR git, which is more than I can handle at the moment).

My reasoning is that from the available chapters, this is my best bet (as a new user) for finding this information; pointing them elsewhere isn't that big a distraction (it's at the top and short) and would be a great help for people looking for that kind of info.

My two cents anyway.




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux