mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-02-20 08:29:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

dev-manual: Edits to "Using Email to Submit a Patch" section.

Browse Source 
(From yocto-docs rev: 9662debc970e3c1db84a9831760174e57b9c48ce)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2013-04-09 15:22:44 -07:00
committed by Richard Purdie
parent 26bf080f24
commit b52a4d3f08
1 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
documentation/dev-manual/dev-manual-newbie.xml
View File

@@ -1439,16 +1439,16 @@
<para> <para>
You can submit patches without using the <filename>create-pull-request</filename> and You can submit patches without using the <filename>create-pull-request</filename> and
<filename>send-pull-request</filename> scripts described in the previous section. <filename>send-pull-request</filename> scripts described in the previous section.
Keep in mind, the preferred method is to use the scripts, however. However, keep in mind, the preferred method is to use the scripts.
</para> </para>
<para> <para>
Depending on the components changed, you need to submit the email to a specific Depending on the components changed, you need to submit the email to a specific
mailing list. mailing list.
For some guidance on which mailing list to use, see the list in the For some guidance on which mailing list to use, see the list in the
"<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" section "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
earlier in this manual. section.
For a description of the available mailing lists, see For a description of the available mailing lists, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>" "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>"
section in the Yocto Project Reference Manual. section in the Yocto Project Reference Manual.
</para> </para>
@@ -1465,7 +1465,7 @@
Using the <filename>--signoff</filename> option identifies you as the person Using the <filename>--signoff</filename> option identifies you as the person
making the change and also satisfies the Developer's Certificate of making the change and also satisfies the Developer's Certificate of
Origin (DCO) shown earlier.</para> Origin (DCO) shown earlier.</para>
<para>When you form a commit you must follow certain standards established by the <para>When you form a commit, you must follow certain standards established by the
Yocto Project development team. Yocto Project development team.
See the earlier section See the earlier section
"<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
@@ -1474,17 +1474,21 @@
To format commits, use the <filename>git format-patch</filename> command. To format commits, use the <filename>git format-patch</filename> command.
When you provide the command, you must include a revision list or a number of patches When you provide the command, you must include a revision list or a number of patches
as part of the command. as part of the command.
For example, these two commands each take the most recent single commit and For example, either of these two commands takes your most
format it as an email message in the current directory: recent single commit and formats it as an email message in
the current directory:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ git format-patch -1 $ git format-patch -1
</literallayout>
or
<literallayout class='monospaced'>
$ git format-patch HEAD~ $ git format-patch HEAD~
</literallayout></para> </literallayout></para>
<para>After the command is run, the current directory contains a <para>After the command is run, the current directory contains a
numbered <filename>.patch</filename> file for the commit.</para> numbered <filename>.patch</filename> file for the commit.</para>
<para>If you provide several commits as part of the command, <para>If you provide several commits as part of the command,
the <filename>git format-patch</filename> command produces a numbered the <filename>git format-patch</filename> command produces a
series of files in the current directory – one for each commit. series of numbered files in the current directory – one for each commit.
If you have more than one patch, you should also use the If you have more than one patch, you should also use the
<filename>--cover</filename> option with the command, which generates a <filename>--cover</filename> option with the command, which generates a
cover letter as the first "patch" in the series. cover letter as the first "patch" in the series.
@@ -1520,7 +1524,9 @@
The command also has several options that let you The command also has several options that let you
specify recipients and perform further editing of the email message. specify recipients and perform further editing of the email message.
For information on how to use the <filename>git send-email</filename> command, For information on how to use the <filename>git send-email</filename> command,
use the <filename>man git-send-email</filename> command.</para></listitem> see <filename>GIT-SEND-EMAIL(1)</filename> displayed using
the <filename>man git-send-email</filename> command.
</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>