[PATCH v6 0/8] docs: recommend using contrib/contacts/git-contacts
- From
- Linus Arver via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Apr 18, 2024, 21:51 UTC
- Message-ID
- <pull.1704.v6.git.1713477125.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.1704.v5.git.1713308518.gitgitgadget@gmail.com>
Make git-contacts more prominent in our docs.
Notable changes in v6 =====================
* Prefix the command with "perl" to avoid the need to have it installed at /usr/bin/perl per the shebang line in git-contacts. * Drop "you must have Perl installed in your system" guidance because it's a bit moot now given the explicit call to "perl".
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 | 9 ++++ Documentation/SubmittingPatches | 72 ++++++++++++++++----------- 2 files changed, 51 insertions(+), 30 deletions(-)
base-commit: c2cbfbd2e28cbe27c194d62183b42f27a6a5bb87 Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1704%2Flistx%2Freviewers-v6 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1704/listx/reviewers-v6 Pull-Request: https://github.com/gitgitgadget/git/pull/1704
Range-diff vs v5:
1: d2c9551ee0e ! 1: 4ced981b82e MyFirstContribution: mention contrib/contacts/git-contacts
@@ Documentation/MyFirstContribution.txt: $ git send-email --to=target@example.com
+: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).]
++codebase and run `perl contrib/contacts/git-contacts`.]
+
+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='contrib/contacts/git-contacts' feature/*.patch`{contrib-scripts} to
++--cc-cmd='perl 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: 92d72a8a25a ! 2: f26f0695f40 SubmittingPatches: clarify 'git-contacts' location
@@ Documentation/SubmittingPatches: security relevant should not be submitted to th
+: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).]
++codebase and run `perl contrib/contacts/git-contacts`.]
+
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: 7c4cc5a91f0 = 3: c201b313644 SubmittingPatches: mention GitGitGadget
4: 621912a64fb = 4: 0a79615cf2f SubmittingPatches: quote commands
5: 8f44343c482 ! 5: aac5dea0bfa SubmittingPatches: discuss reviewers first
@@ Documentation/SubmittingPatches: letter.
+
+: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).]
++codebase and run `perl contrib/contacts/git-contacts`.]
+
+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
-
-: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).]
+-codebase and run `perl contrib/contacts/git-contacts`.]
-
-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: fd8ad38cab0 = 6: 333775d4129 SubmittingPatches: dedupe discussion of security patches
7: b23c73459cc = 7: ef031e30047 SubmittingPatches: add heading for format-patch and send-email
8: 911d4f2a0e5 ! 8: f346da95ee2 SubmittingPatches: demonstrate using git-contacts with git-send-email
@@ Documentation/SubmittingPatches: trial merges of your topic to `next` and `seen`
+this:
+
+....
-+ git send-email --cc-cmd='contrib/contacts/git-contacts' feature/*.patch
++ git send-email --cc-cmd='perl contrib/contacts/git-contacts' feature/*.patch
+....
+
:current-maintainer: footnote:[The current maintainer: gitster@pobox.com]-- gitgitgadget