diff options
| author | Junio C Hamano <gitster@pobox.com> | 2024-05-01 10:58:22 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-05-01 10:58:22 -0700 |
| commit | 7af7f87d1682bc0221ef8ef496126c204d35760d (patch) | |
| tree | 78a7acd5d4f7a8b7db6b1f44bcb506f7bb5feefb /SubmittingPatches.html | |
| parent | a181e55f63bee8d3a44fd0be402039db41158169 (diff) | |
| download | git-htmldocs-7af7f87d1682bc0221ef8ef496126c204d35760d.tar.gz | |
Autogenerated HTML docs for v2.45.0-31-gd4cc1
Diffstat (limited to 'SubmittingPatches.html')
| -rw-r--r-- | SubmittingPatches.html | 73 |
1 files changed, 49 insertions, 24 deletions
diff --git a/SubmittingPatches.html b/SubmittingPatches.html index 01f72c411..4ff7c396a 100644 --- a/SubmittingPatches.html +++ b/SubmittingPatches.html @@ -735,7 +735,7 @@ asciidoc.install(); <body class="article">
<div id="header">
<h1>Submitting Patches</h1>
-<span id="revdate">2024-04-29</span>
+<span id="revdate">2024-04-30</span>
</div>
<div id="content">
<div class="sect1">
@@ -1201,13 +1201,56 @@ letter.</td> </div>
<div class="sect2">
<h3 id="send-patches">Sending your patches.</h3>
-<div class="paragraph"><p>Before sending any patches, please note that patches that may be
+<div class="sect3">
+<h4 id="_choosing_your_reviewers">Choosing your reviewers</h4>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">Patches that may be
security relevant should be submitted privately to the Git Security
-mailing list<span class="footnote" id="_footnote_security-ml"><br />[The Git Security mailing list: <a href="mailto:git-security@googlegroups.com">git-security@googlegroups.com</a>]<br /></span>, instead of the public mailing list.</p></div>
-<div class="paragraph"><p>Learn to use format-patch and send-email if possible. These commands
+mailing list<span class="footnote" id="_footnote_security-ml"><br />[The Git Security mailing list: <a href="mailto:git-security@googlegroups.com">git-security@googlegroups.com</a>]<br /></span>, instead of the public mailing list.</td>
+</tr></table>
+</div>
+<div class="paragraph"><p>Send your patch with "To:" set to the mailing list, with "cc:" listing
+people who are involved in the area you are touching (the <code>git-contacts</code>
+script in <code>contrib/contacts/</code><span class="footnote" id="_footnote_contrib-scripts"><br />[Scripts under <code>contrib/</code> are not part of the core <code>git</code> binary and must be called directly. Clone the Git codebase and run <code>perl contrib/contacts/git-contacts</code>.]<br /></span> can help to
+identify them), to solicit comments and reviews. Also, when you made
+trial merges of your topic to <code>next</code> and <code>seen</code>, you may have noticed
+work by others conflicting with your changes. There is a good possibility
+that these people may know the area you are touching well.</p></div>
+<div class="paragraph"><p>If you are using <code>send-email</code>, you can feed it the output of <code>git-contacts</code> like
+this:</p></div>
+<div class="literalblock">
+<div class="content">
+<pre><code> git send-email --cc-cmd='perl contrib/contacts/git-contacts' feature/*.patch</code></pre>
+</div></div>
+<div class="paragraph"><p>After the list reached a consensus that it is a good idea to apply the
+patch, re-send it with "To:" set to the maintainer<span class="footnote"><br />[The current maintainer: <a href="mailto:gitster@pobox.com">gitster@pobox.com</a>]<br /></span>
+and "cc:" the list<span class="footnote"><br />[The mailing list: <a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>]<br /></span> for inclusion. This is especially relevant
+when the maintainer did not heavily participate in the discussion and
+instead left the review to trusted others.</p></div>
+<div class="paragraph"><p>Do not forget to add trailers such as <code>Acked-by:</code>, <code>Reviewed-by:</code> and
+<code>Tested-by:</code> lines as necessary to credit people who helped your
+patch, and "cc:" them when sending such a final version for inclusion.</p></div>
+</div>
+<div class="sect3">
+<h4 id="_code_format_patch_code_and_code_send_email_code"><code>format-patch</code> and <code>send-email</code></h4>
+<div class="paragraph"><p>Learn to use <code>format-patch</code> and <code>send-email</code> if possible. These commands
are optimized for the workflow of sending patches, avoiding many ways
your existing e-mail client (often optimized for "multipart/*" MIME
type e-mails) might render your patches unusable.</p></div>
+<div class="admonitionblock">
+<table><tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">Here we outline the procedure using <code>format-patch</code> and
+<code>send-email</code>, but you can instead use GitGitGadget to send in your
+patches (see <a href="MyFirstContribution.html">MyFirstContribution</a>).</td>
+</tr></table>
+</div>
<div class="paragraph"><p>People on the Git mailing list need to be able to read and
comment on the changes you are submitting. It is important for
a developer to be able to "quote" your changes, using standard
@@ -1289,25 +1332,7 @@ origin that is done poorly or does incorrect things.</p></div> patch, format it as "multipart/signed", not a text/plain message
that starts with <code>-----BEGIN PGP SIGNED MESSAGE-----</code>. That is
not a text/plain, it’s something else.</p></div>
-<div class="paragraph"><p>As mentioned at the beginning of the section, patches that may be
-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<span class="footnoteref"><br /><a href="#_footnote_security-ml">[security-ml]</a><br /></span>.</p></div>
-<div class="paragraph"><p>Send your patch with "To:" set to the mailing list, with "cc:" listing
-people who are involved in the area you are touching (the <code>git
-contacts</code> command in <code>contrib/contacts/</code> can help to
-identify them), to solicit comments and reviews. Also, when you made
-trial merges of your topic to <code>next</code> and <code>seen</code>, you may have noticed
-work by others conflicting with your changes. There is a good possibility
-that these people may know the area you are touching well.</p></div>
-<div class="paragraph"><p>After the list reached a consensus that it is a good idea to apply the
-patch, re-send it with "To:" set to the maintainer<span class="footnote"><br />[The current maintainer: <a href="mailto:gitster@pobox.com">gitster@pobox.com</a>]<br /></span>
-and "cc:" the list<span class="footnote"><br />[The mailing list: <a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>]<br /></span> for inclusion. This is especially relevant
-when the maintainer did not heavily participate in the discussion and
-instead left the review to trusted others.</p></div>
-<div class="paragraph"><p>Do not forget to add trailers such as <code>Acked-by:</code>, <code>Reviewed-by:</code> and
-<code>Tested-by:</code> lines as necessary to credit people who helped your
-patch, and "cc:" them when sending such a final version for inclusion.</p></div>
+</div>
</div>
</div>
</div>
@@ -1555,7 +1580,7 @@ this problem around.</p></div> <div id="footer">
<div id="footer-text">
Last updated
- 2024-04-29 08:08:14 PDT
+ 2024-05-01 10:56:52 PDT
</div>
</div>
</body>
|