summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-09 15:22:44 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-10 16:20:57 +0100
commitb52a4d3f088136c1347bf4d2ad2cc052d87ba2b6 (patch)
treec20220a8fd98e147ac1e222ecadd1509b11aa38f /documentation/dev-manual/dev-manual-newbie.xml
parent26bf080f243a66be9bcc7a91aa36e20a4e589750 (diff)
downloadpoky-b52a4d3f088136c1347bf4d2ad2cc052d87ba2b6.tar.gz
dev-manual: Edits to "Using Email to Submit a Patch" section.
(From yocto-docs rev: 9662debc970e3c1db84a9831760174e57b9c48ce) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml26
1 files changed, 16 insertions, 10 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index d939b44c54..6d5650ae05 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -1439,16 +1439,16 @@
1439 <para> 1439 <para>
1440 You can submit patches without using the <filename>create-pull-request</filename> and 1440 You can submit patches without using the <filename>create-pull-request</filename> and
1441 <filename>send-pull-request</filename> scripts described in the previous section. 1441 <filename>send-pull-request</filename> scripts described in the previous section.
1442 Keep in mind, the preferred method is to use the scripts, however. 1442 However, keep in mind, the preferred method is to use the scripts.
1443 </para> 1443 </para>
1444 1444
1445 <para> 1445 <para>
1446 Depending on the components changed, you need to submit the email to a specific 1446 Depending on the components changed, you need to submit the email to a specific
1447 mailing list. 1447 mailing list.
1448 For some guidance on which mailing list to use, see the list in the 1448 For some guidance on which mailing list to use, see the list in the
1449 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" section 1449 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
1450 earlier in this manual. 1450 section.
1451 For a description of the available mailing lists, see 1451 For a description of the available mailing lists, see the
1452 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>" 1452 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>"
1453 section in the Yocto Project Reference Manual. 1453 section in the Yocto Project Reference Manual.
1454 </para> 1454 </para>
@@ -1465,7 +1465,7 @@
1465 Using the <filename>--signoff</filename> option identifies you as the person 1465 Using the <filename>--signoff</filename> option identifies you as the person
1466 making the change and also satisfies the Developer's Certificate of 1466 making the change and also satisfies the Developer's Certificate of
1467 Origin (DCO) shown earlier.</para> 1467 Origin (DCO) shown earlier.</para>
1468 <para>When you form a commit you must follow certain standards established by the 1468 <para>When you form a commit, you must follow certain standards established by the
1469 Yocto Project development team. 1469 Yocto Project development team.
1470 See the earlier section 1470 See the earlier section
1471 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" 1471 "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>"
@@ -1474,17 +1474,21 @@
1474 To format commits, use the <filename>git format-patch</filename> command. 1474 To format commits, use the <filename>git format-patch</filename> command.
1475 When you provide the command, you must include a revision list or a number of patches 1475 When you provide the command, you must include a revision list or a number of patches
1476 as part of the command. 1476 as part of the command.
1477 For example, these two commands each take the most recent single commit and 1477 For example, either of these two commands takes your most
1478 format it as an email message in the current directory: 1478 recent single commit and formats it as an email message in
1479 the current directory:
1479 <literallayout class='monospaced'> 1480 <literallayout class='monospaced'>
1480 $ git format-patch -1 1481 $ git format-patch -1
1482 </literallayout>
1483 or
1484 <literallayout class='monospaced'>
1481 $ git format-patch HEAD~ 1485 $ git format-patch HEAD~
1482 </literallayout></para> 1486 </literallayout></para>
1483 <para>After the command is run, the current directory contains a 1487 <para>After the command is run, the current directory contains a
1484 numbered <filename>.patch</filename> file for the commit.</para> 1488 numbered <filename>.patch</filename> file for the commit.</para>
1485 <para>If you provide several commits as part of the command, 1489 <para>If you provide several commits as part of the command,
1486 the <filename>git format-patch</filename> command produces a numbered 1490 the <filename>git format-patch</filename> command produces a
1487 series of files in the current directory – one for each commit. 1491 series of numbered files in the current directory – one for each commit.
1488 If you have more than one patch, you should also use the 1492 If you have more than one patch, you should also use the
1489 <filename>--cover</filename> option with the command, which generates a 1493 <filename>--cover</filename> option with the command, which generates a
1490 cover letter as the first "patch" in the series. 1494 cover letter as the first "patch" in the series.
@@ -1520,7 +1524,9 @@
1520 The command also has several options that let you 1524 The command also has several options that let you
1521 specify recipients and perform further editing of the email message. 1525 specify recipients and perform further editing of the email message.
1522 For information on how to use the <filename>git send-email</filename> command, 1526 For information on how to use the <filename>git send-email</filename> command,
1523 use the <filename>man git-send-email</filename> command.</para></listitem> 1527 see <filename>GIT-SEND-EMAIL(1)</filename> displayed using
1528 the <filename>man git-send-email</filename> command.
1529 </para></listitem>
1524 </itemizedlist> 1530 </itemizedlist>
1525 </para> 1531 </para>
1526 </section> 1532 </section>