From: "Linus Arver via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
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>,
Linus Arver <linusa@google.com>
Subject: [PATCH v5 0/8] docs: recommend using contrib/contacts/git-contacts
Date: Tue, 16 Apr 2024 23:01:49 +0000 [thread overview]
Message-ID: <pull.1704.v5.git.1713308518.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1704.v4.git.1712878339.gitgitgadget@gmail.com>
Make git-contacts more prominent in our docs.
Notable changes in v5
=====================
* Drop mention of "/usr/share/..." as an "installed" path for
"git-contacts"; instead point users to the script as a relative path
inside the Git codebase
* Minor wording tweaks to commit messages
Notable changes in v4
=====================
* Avoid using "should" for guidance around using "git-contacts"
* Clarify where to find the "git-contacts" script (because it's not a
default builtin command)
Notable changes in v3
=====================
* Refer to GitGitGadget via a link to MyFirstContribution (instead of
sending readers to GGG's homepage directly)
* Soften the advice for using git-contacts
Notable changes in v2
=====================
* Improve existing mention of git-contacts in SubmittingPatches (instead of
adding a separate, entirely new paragraph)
* Add example usage of integrating git-contacts with git-send-email with
the latter's --cc-cmd flag.
* Various smaller fixes to SubmittingPatches
Linus Arver (8):
MyFirstContribution: mention contrib/contacts/git-contacts
SubmittingPatches: clarify 'git-contacts' location
SubmittingPatches: mention GitGitGadget
SubmittingPatches: quote commands
SubmittingPatches: discuss reviewers first
SubmittingPatches: dedupe discussion of security patches
SubmittingPatches: add heading for format-patch and send-email
SubmittingPatches: demonstrate using git-contacts with git-send-email
Documentation/MyFirstContribution.txt | 10 ++++
Documentation/SubmittingPatches | 73 ++++++++++++++++-----------
2 files changed, 53 insertions(+), 30 deletions(-)
base-commit: c2cbfbd2e28cbe27c194d62183b42f27a6a5bb87
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1704%2Flistx%2Freviewers-v5
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1704/listx/reviewers-v5
Pull-Request: https://github.com/gitgitgadget/git/pull/1704
Range-diff vs v4:
1: ad469e4e6db ! 1: d2c9551ee0e MyFirstContribution: mention contrib/contacts/git-contacts
@@ Documentation/MyFirstContribution.txt: $ git send-email --to=target@example.com
NOTE: Check `git help send-email` for some other options which you may find
valuable, such as changing the Reply-to address or adding more CC and BCC lines.
-+: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.]
++:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
++not part of the core `git` binary and must be called directly. Clone the Git +
++codebase and run `contrib/contacts/git-contacts` (you must have Perl installed +
++in your system).]
+
+NOTE: If you're not sure whom to CC, running `contrib/contacts/git-contacts` can
+list potential reviewers. In addition, you can do `git send-email
-+--cc-cmd='/path/to/git-contacts' feature/*.patch`{contrib-scripts} to
++--cc-cmd='contrib/contacts/git-contacts' feature/*.patch`{contrib-scripts} to
+automatically pass this list of emails to `send-email`.
+
NOTE: When you are sending a real patch, it will go to git@vger.kernel.org - but
2: c43de19d867 ! 2: 92d72a8a25a SubmittingPatches: clarify 'git-contacts' location
@@ Metadata
## Commit message ##
SubmittingPatches: clarify 'git-contacts' location
- Use a dash ("git-contacts", not "git contacts") because the script
- is not a core builtin command that is compiled into the `git` binary.
- This also puts the script on one line, which should make it easier to
- grep for with a loose search query, such as
+ Use a dash ("git-contacts", not "git contacts") because the script is
+ not installed as part of "git" toolset. 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
- located, to help readers who may not be familiar with such "contrib"
- scripts (and how they are not accessible with the usual "git
- <subcommand>" syntax).
+ Also add a footnote to describe where the script is located, to help
+ readers who may not be familiar with such "contrib" scripts (and how
+ they are not accessible with the usual "git <subcommand>" syntax).
Signed-off-by: Linus Arver <linusa@google.com>
@@ Documentation/SubmittingPatches: security relevant should not be submitted to th
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.]
++:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
++not part of the core `git` binary and must be called directly. Clone the Git +
++codebase and run `contrib/contacts/git-contacts` (you must have Perl installed +
++in your system).]
+
Send your patch with "To:" set to the mailing list, with "cc:" listing
-people who are involved in the area you are touching (the `git
3: cd941704176 = 3: 7c4cc5a91f0 SubmittingPatches: mention GitGitGadget
4: 44470a5d70e = 4: 621912a64fb SubmittingPatches: quote commands
5: 15f9356ff97 ! 5: 8f44343c482 SubmittingPatches: discuss reviewers first
@@ Documentation/SubmittingPatches: letter.
+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.]
++:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
++not part of the core `git` binary and must be called directly. Clone the Git +
++codebase and run `contrib/contacts/git-contacts` (you must have Perl installed +
++in your system).]
+
+Send your patch with "To:" set to the mailing list, with "cc:" listing
+people who are involved in the area you are touching (the `git-contacts`
@@ Documentation/SubmittingPatches: patch, format it as "multipart/signed", not a t
-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.]
+-:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
+-not part of the core `git` binary and must be called directly. Clone the Git +
+-codebase and run `contrib/contacts/git-contacts` (you must have Perl installed +
+-in your system).]
-
-Send your patch with "To:" set to the mailing list, with "cc:" listing
-people who are involved in the area you are touching (the `git-contacts`
6: e889e64bd45 ! 6: fd8ad38cab0 SubmittingPatches: dedupe discussion of security patches
@@ Documentation/SubmittingPatches: letter.
+security relevant should be submitted privately to the Git Security
+mailing list{security-ml}, instead of the public mailing list.
- :contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are not +
- part of the core `git` binary and must be called separately. Consult your +
+ :contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
+ not part of the core `git` binary and must be called directly. Clone the Git +
@@ Documentation/SubmittingPatches: Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
`Tested-by:` lines as necessary to credit people who helped your
patch, and "cc:" them when sending such a final version for inclusion.
7: 81556298599 = 7: b23c73459cc SubmittingPatches: add heading for format-patch and send-email
8: 84b1cf3f914 ! 8: 911d4f2a0e5 SubmittingPatches: demonstrate using git-contacts with git-send-email
@@ Documentation/SubmittingPatches: trial merges of your topic to `next` and `seen`
work by others conflicting with your changes. There is a good possibility
that these people may know the area you are touching well.
-+If you are using `send-email`, you can feed it the output of `git contacts` like
++If you are using `send-email`, you can feed it the output of `git-contacts` like
+this:
+
+....
-+ git send-email --cc-cmd='git contacts' feature/*.patch
++ git send-email --cc-cmd='contrib/contacts/git-contacts' feature/*.patch
+....
+
:current-maintainer: footnote:[The current maintainer: gitster@pobox.com]
--
gitgitgadget
next prev parent reply other threads:[~2024-04-16 23:02 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
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 ` Linus Arver via GitGitGadget [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1704.v5.git.1713308518.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@matthieu-moy.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jonathantanmy@google.com \
--cc=kipras@kipras.org \
--cc=linusa@google.com \
--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.
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).