From: Linus Arver <linusa@google.com>
To: Junio C Hamano <gitster@pobox.com>,
Linus Arver via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org,
Johannes Schindelin <Johannes.Schindelin@gmx.de>,
Jonathan Tan <jonathantanmy@google.com>,
Emily Shaffer <nasamuffin@google.com>,
Patrick Steinhardt <ps@pks.im>,
Matthieu Moy <git@matthieu-moy.fr>,
Eric Sunshine <sunshine@sunshineco.com>,
Kipras Melnikovas <kipras@kipras.org>
Subject: Re: [PATCH v4 2/8] SubmittingPatches: clarify 'git-contacts' location
Date: Tue, 16 Apr 2024 15:44:44 -0700 [thread overview]
Message-ID: <owly34rl53mr.fsf@fine.c.googlers.com> (raw)
In-Reply-To: <xmqqsezqmrtd.fsf@gitster.g>
Junio C Hamano <gitster@pobox.com> writes:
> "Linus Arver via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> From: Linus Arver <linusa@google.com>
>>
>> Use a dash ("git-contacts", not "git contacts") because the script
>> is not a core builtin command that is compiled into the `git` binary.
>
> Pedantic, but "git mergetool" is how it is spelled even though it is
> not a core builtin command and is not compiled into the binary. The
> reason why "git-contacts" is better is because we do not install it
> to be usable by user's "git".
>
> ... because the script is not installed as part of "git"
> toolset.
Noted; I will use this wording.
> An obvious alternative of course is to promote "contacts" out of
> "contrib/" and install it as part of the standard toolset. I gave a
> brief scan of the script and did not find anything (other than "only
> the recent 5 years worth of history matters") that is too specific
> to our project and I suspect it should do a reasonable job when run
> in any repository/working tree of a git-managed project.
>
> But it is outside the scope of this series. I'd still welcome the
> thought to do that after the dust settles, though.
Ack. Ideally we would translate it to C (or, dare I say, into a C lib +
some other higher level language, Perl or otherwise), but I agree that's
for another series.
>> This also puts the script on one line, which should make it easier to
>> grep for with a loose search query, such as
>>
>> $ git grep git.contacts Documentation
>>
>> . Also add a footnote to describe where the script could actually be
>
> Let's drop ". "
Will do.
> ; it may leave the previous sentence appear hanging
> unterminated, but the capital A that begins a new sentence is a good
> enough sign that we finished the previous sentence, isn't it?
In hindsight I agree. From a quick Google search [1] it looks like your
style is what's preferred in academia also.
>> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
>> index e734a3f0f17..8b6e4bf0300 100644
>> --- a/Documentation/SubmittingPatches
>> +++ b/Documentation/SubmittingPatches
>> @@ -493,9 +493,16 @@ security relevant should not be submitted to the public mailing list
>> mentioned below, but should instead be sent privately to the Git
>> Security mailing list{security-ml-ref}.
>>
>> +:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are not +
>> +part of the core `git` binary and must be called separately. Consult your +
>> +package manager to determine where it is located. For example, on Ubuntu-based +
>> +systems it could be installed under +
>> +`/usr/share/doc/git/contrib/contacts/git-contacts` and may need to be called +
>> +with `perl ...` if it does not have the executable bit set.]
>
> I wouldn't call anything in /usr/share/doc/ "installed", though.
>
> In the context of _this_ document where the user is working on _git_
> project towards submitting patches to _us_, it is far simpler to
> drop the above paragraph and tell them how to run the script in
> contrib/, e.g.
>
> $ perl contrib/contacts/git-contacts <args>...
>
> without hinting there is anything platform/distro specific, and
> instead to have them all work from our sources.
Indeed. One small change is that the script already has the execute bit
set so I can drop `perl` as $0 (the execute bit is removed when it is
copied into /usr/share/... on my system).
> I am assuming that any user who are reading this part of the
> document would have a reasonably recent version of our sources
> checked out (after all, they already have a patch or two to send but
> they are learning the way to find whom to send them to).
Agreed.
[1] https://camosun.libguides.com/Chicago-17thEd/quotations
next prev parent reply other threads:[~2024-04-16 22:44 UTC|newest]
Thread overview: 88+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-02 0:20 [PATCH] docs: recommend using contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-02 6:28 ` Patrick Steinhardt
2024-04-04 20:00 ` Linus Arver
2024-04-03 8:42 ` Matthias Aßhauer
2024-04-03 16:13 ` Junio C Hamano
2024-04-04 20:01 ` Linus Arver
[not found] ` <35192e61-c442-6719-caf0-1019bf3e44c9@live.de>
2024-04-03 10:11 ` [RFC] git-contacts: exclude list (was: Re: [PATCH] docs: recommend using contrib/contacts/git-contacts) Matthias Aßhauer
2024-04-03 16:39 ` [RFC] git-contacts: exclude list Junio C Hamano
[not found] ` <ac044ecd116d4491b5f6cdddc0266486@SAMBXP02.univ-lyon1.fr>
2024-04-03 12:13 ` Matthieu Moy
2024-04-06 1:22 ` [PATCH v2 0/8] docs: recommend using contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-06 1:22 ` [PATCH v2 1/8] MyFirstContribution: mention contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-06 2:22 ` Junio C Hamano
2024-04-09 1:08 ` Linus Arver
2024-04-09 1:49 ` Junio C Hamano
2024-04-06 1:22 ` [PATCH v2 2/8] SubmittingPatches: make 'git contacts' grep-friendly Linus Arver via GitGitGadget
2024-04-06 2:23 ` Junio C Hamano
2024-04-06 1:22 ` [PATCH v2 3/8] SubmittingPatches: mention GitGitGadget Linus Arver via GitGitGadget
2024-04-06 2:26 ` Junio C Hamano
2024-04-09 1:10 ` Linus Arver
2024-04-09 1:49 ` Junio C Hamano
2024-04-06 1:22 ` [PATCH v2 4/8] SubmittingPatches: quote commands Linus Arver via GitGitGadget
2024-04-06 1:22 ` [PATCH v2 5/8] SubmittingPatches: discuss reviewers first Linus Arver via GitGitGadget
2024-04-06 1:22 ` [PATCH v2 6/8] SubmittingPatches: dedupe discussion of security patches Linus Arver via GitGitGadget
2024-04-06 1:22 ` [PATCH v2 7/8] SubmittingPatches: add heading for format-patch and send-email Linus Arver via GitGitGadget
2024-04-06 1:22 ` [PATCH v2 8/8] SubmittingPatches: demonstrate using git-contacts with git-send-email Linus Arver via GitGitGadget
2024-04-06 2:28 ` [PATCH v2 0/8] docs: recommend using contrib/contacts/git-contacts Junio C Hamano
2024-04-09 21:56 ` [PATCH v3 " Linus Arver via GitGitGadget
2024-04-09 21:56 ` [PATCH v3 1/8] MyFirstContribution: mention contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-09 22:20 ` Linus Arver
2024-04-09 23:02 ` Junio C Hamano
2024-04-09 23:42 ` Linus Arver
2024-04-11 22:53 ` Linus Arver
2024-04-09 21:56 ` [PATCH v3 2/8] SubmittingPatches: make 'git contacts' grep-friendly Linus Arver via GitGitGadget
2024-04-09 21:56 ` [PATCH v3 3/8] SubmittingPatches: mention GitGitGadget Linus Arver via GitGitGadget
2024-04-09 21:56 ` [PATCH v3 4/8] SubmittingPatches: quote commands Linus Arver via GitGitGadget
2024-04-09 21:56 ` [PATCH v3 5/8] SubmittingPatches: discuss reviewers first Linus Arver via GitGitGadget
2024-04-10 0:27 ` Eric Sunshine
2024-04-10 0:36 ` Junio C Hamano
2024-04-10 1:13 ` Linus Arver
2024-04-09 21:56 ` [PATCH v3 6/8] SubmittingPatches: dedupe discussion of security patches Linus Arver via GitGitGadget
2024-04-09 21:56 ` [PATCH v3 7/8] SubmittingPatches: add heading for format-patch and send-email Linus Arver via GitGitGadget
2024-04-09 21:56 ` [PATCH v3 8/8] SubmittingPatches: demonstrate using git-contacts with git-send-email Linus Arver via GitGitGadget
2024-04-11 0:19 ` Kipras Melnikovas
2024-04-11 21:03 ` Linus Arver
2024-04-12 8:48 ` Kipras Melnikovas
2024-04-11 23:32 ` [PATCH v4 0/8] docs: recommend using contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 1/8] MyFirstContribution: mention contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 2/8] SubmittingPatches: clarify 'git-contacts' location Linus Arver via GitGitGadget
2024-04-12 17:09 ` Junio C Hamano
2024-04-12 18:45 ` Eric Sunshine
2024-04-13 1:26 ` Junio C Hamano
2024-04-16 22:44 ` Linus Arver [this message]
2024-04-16 22:57 ` Junio C Hamano
2024-04-16 23:07 ` Linus Arver
2024-04-17 2:40 ` Junio C Hamano
2024-04-17 5:38 ` Junio C Hamano
2024-04-17 5:48 ` Eric Sunshine
2024-04-17 14:47 ` Junio C Hamano
2024-04-17 23:13 ` Linus Arver
2024-04-17 23:08 ` Linus Arver
2024-04-18 18:13 ` Linus Arver
2024-04-11 23:32 ` [PATCH v4 3/8] SubmittingPatches: mention GitGitGadget Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 4/8] SubmittingPatches: quote commands Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 5/8] SubmittingPatches: discuss reviewers first Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 6/8] SubmittingPatches: dedupe discussion of security patches Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 7/8] SubmittingPatches: add heading for format-patch and send-email Linus Arver via GitGitGadget
2024-04-11 23:32 ` [PATCH v4 8/8] SubmittingPatches: demonstrate using git-contacts with git-send-email Linus Arver via GitGitGadget
2024-04-12 17:19 ` Junio C Hamano
2024-04-16 0:21 ` Linus Arver
2024-04-16 23:01 ` [PATCH v5 0/8] docs: recommend using contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 1/8] MyFirstContribution: mention contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 2/8] SubmittingPatches: clarify 'git-contacts' location Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 3/8] SubmittingPatches: mention GitGitGadget Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 4/8] SubmittingPatches: quote commands Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 5/8] SubmittingPatches: discuss reviewers first Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 6/8] SubmittingPatches: dedupe discussion of security patches Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 7/8] SubmittingPatches: add heading for format-patch and send-email Linus Arver via GitGitGadget
2024-04-16 23:01 ` [PATCH v5 8/8] SubmittingPatches: demonstrate using git-contacts with git-send-email Linus Arver via GitGitGadget
2024-04-18 21:51 ` [PATCH v6 0/8] docs: recommend using contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-18 21:51 ` [PATCH v6 1/8] MyFirstContribution: mention contrib/contacts/git-contacts Linus Arver via GitGitGadget
2024-04-18 21:51 ` [PATCH v6 2/8] SubmittingPatches: clarify 'git-contacts' location Linus Arver via GitGitGadget
2024-04-18 21:52 ` [PATCH v6 3/8] SubmittingPatches: mention GitGitGadget Linus Arver via GitGitGadget
2024-04-18 21:52 ` [PATCH v6 4/8] SubmittingPatches: quote commands Linus Arver via GitGitGadget
2024-04-18 21:52 ` [PATCH v6 5/8] SubmittingPatches: discuss reviewers first Linus Arver via GitGitGadget
2024-04-18 21:52 ` [PATCH v6 6/8] SubmittingPatches: dedupe discussion of security patches Linus Arver via GitGitGadget
2024-04-18 21:52 ` [PATCH v6 7/8] SubmittingPatches: add heading for format-patch and send-email Linus Arver via GitGitGadget
2024-04-18 21:52 ` [PATCH v6 8/8] SubmittingPatches: demonstrate using git-contacts with git-send-email Linus Arver via GitGitGadget
2024-04-18 21:56 ` [PATCH v6 0/8] docs: recommend using contrib/contacts/git-contacts Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=owly34rl53mr.fsf@fine.c.googlers.com \
--to=linusa@google.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@matthieu-moy.fr \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=jonathantanmy@google.com \
--cc=kipras@kipras.org \
--cc=nasamuffin@google.com \
--cc=ps@pks.im \
--cc=sunshine@sunshineco.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).