From: Kenneth Lorber <keni@his.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Kenneth Lorber <keni@hers.com>, git@vger.kernel.org
Subject: Re: [RFC PATCH 2/6] Add bit on extending git to Hacking Git
Date: Mon, 18 May 2020 18:10:00 -0400 [thread overview]
Message-ID: <07D99191-664E-475C-A9B1-7FE4DB5C2165@his.com> (raw)
In-Reply-To: <xmqqzha65s1l.fsf@gitster.c.googlers.com>
> On May 17, 2020, at 2:34 PM, Junio C Hamano <gitster@pobox.com> wrote:
>
> Kenneth Lorber <keni@hers.com> writes:
>
>> From: Kenneth Lorber <keni@his.com>
>>
>> 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@his.com>
>> ---
>> 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.
next prev parent reply other threads:[~2020-05-18 22:10 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-17 2:13 [RFC PATCH 0/6] various documentation bits Kenneth Lorber
2020-05-17 2:13 ` [RFC PATCH 1/6] Tell the glossary about core.hooksPath Kenneth Lorber
2020-05-17 18:33 ` Junio C Hamano
2020-05-18 22:06 ` Kenneth Lorber
2020-05-17 2:13 ` [RFC PATCH 2/6] Add bit on extending git to Hacking Git Kenneth Lorber
2020-05-17 18:34 ` Junio C Hamano
2020-05-18 22:10 ` Kenneth Lorber [this message]
2020-05-17 2:13 ` [RFC PATCH 3/6] Add namespace collision avoidance guidelines file Kenneth Lorber
2020-05-17 9:45 ` Abhishek Kumar
2020-05-18 15:51 ` Kenneth Lorber
2020-05-17 15:31 ` Junio C Hamano
2020-05-18 21:46 ` Kenneth Lorber
2020-05-17 2:13 ` [RFC PATCH 4/6] Include NAMESPACE COLLISIONS doc into gitrepository-layout.txt Kenneth Lorber
2020-05-18 0:26 ` Junio C Hamano
2020-05-18 23:54 ` Kenneth Lorber
2020-05-17 2:13 ` [RFC PATCH 5/6] Tell config.txt about NAMESPACE COLLISIONS Kenneth Lorber
2020-05-18 0:32 ` Junio C Hamano
2020-05-17 2:13 ` [RFC PATCH 6/6] Add NAMESPACE COLLISIONS reference to Hacking Git Kenneth Lorber
2020-05-17 7:42 ` [RFC PATCH 0/6] various documentation bits Abhishek Kumar
2020-05-17 18:39 ` Junio C Hamano
2020-05-18 23:44 ` Kenneth Lorber
2020-05-18 15:45 ` Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 " Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 1/6] doc: Tell the glossary about core.hooksPath Kenneth Lorber
2020-05-26 18:59 ` Junio C Hamano
2020-05-27 16:52 ` Kenneth Lorber
2020-05-27 17:18 ` Kenneth Lorber
2020-05-27 17:18 ` Junio C Hamano
2020-05-25 23:27 ` [RFC PATCH v2 2/6] doc: Add bit on extending git to Hacking Git Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 3/6] doc: Add namespace collision guidelines file Kenneth Lorber
2020-05-28 18:49 ` Junio C Hamano
2020-05-28 19:29 ` Junio C Hamano
2020-05-29 1:20 ` Junio C Hamano
2020-05-29 18:08 ` Junio C Hamano
2020-06-01 23:55 ` Kenneth Lorber
2020-06-01 18:38 ` Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 4/6] doc: Add collision doc to gitrepository-layout.txt Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 5/6] doc: Tell config.txt about namespace collisions Kenneth Lorber
2020-05-25 23:27 ` [RFC PATCH v2 6/6] doc: Add collision reference to Hacking Git Kenneth Lorber
2020-05-31 21:37 ` [RFC PATCH 0/2] update glossary hooks entry Kenneth Lorber
2020-05-31 21:37 ` [RFC PATCH 1/2] doc: Tell the glossary about core.hooksPath Kenneth Lorber
2020-05-31 21:37 ` [RFC PATCH 2/2] doc: remove dated info and refs to sample hooks Kenneth Lorber
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=07D99191-664E-475C-A9B1-7FE4DB5C2165@his.com \
--to=keni@his.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=keni@hers.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).