Skip to content

Commit 824503c

Browse files
Linus Arvergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7e50b3f commit 824503c

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

Documentation/SubmittingPatches

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -493,9 +493,13 @@ security relevant should not be submitted to the public mailing list
493493
mentioned below, but should instead be sent privately to the Git
494494
Security mailing list{security-ml-ref}.
495495

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+
496500
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
499503
identify them), to solicit comments and reviews. Also, when you made
500504
trial merges of your topic to `next` and `seen`, you may have noticed
501505
work by others conflicting with your changes. There is a good possibility

0 commit comments

Comments
 (0)