SubmittingPatches: clarify 'git-contacts' location
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 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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Linus Arver committed
Apr 18, 2024 at 21:51 UTC
824503ce88963b9d7f111215fdce073a504e76e7
1 file changed
+6
-2
Documentation/SubmittingPatches
+6
-2
@@ -493,9 +493,13 @@ security relevant should not be submitted to the public mailing list
493
mentioned below, but should instead be sent privately to the Git
494
Security mailing list{security-ml-ref}.
495
496
+:contrib-scripts: footnoteref:[contrib-scripts,Scripts under `contrib/` are +
497
+not part of the core `git` binary and must be called directly. Clone the Git +
498
+codebase and run `perl contrib/contacts/git-contacts`.]
499
+
500
Send your patch with "To:" set to the mailing list, with "cc:" listing
497
-people who are involved in the area you are touching (the `git
498
-contacts` command in `contrib/contacts/` can help to
501
+people who are involved in the area you are touching (the `git-contacts`
502
+script in `contrib/contacts/`{contrib-scripts} can help to
503
identify them), to solicit comments and reviews. Also, when you made
504
trial merges of your topic to `next` and `seen`, you may have noticed
505
work by others conflicting with your changes. There is a good possibility