diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-09 15:22:44 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-10 16:20:57 +0100 |
commit | b52a4d3f088136c1347bf4d2ad2cc052d87ba2b6 (patch) | |
tree | c20220a8fd98e147ac1e222ecadd1509b11aa38f /documentation/dev-manual/dev-manual-newbie.xml | |
parent | 26bf080f243a66be9bcc7a91aa36e20a4e589750 (diff) | |
download | openembedded-core-contrib-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.xml | 26 |
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 @@ <para> You can submit patches without using the <filename>create-pull-request</filename> and <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> Depending on the components changed, you need to submit the email to a specific mailing list. 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 - earlier in this manual. - For a description of the available mailing lists, see + "<link linkend='how-to-submit-a-change'>How to Submit a Change</link>" + section. + For a description of the available mailing lists, see the "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing Lists</ulink>" section in the Yocto Project Reference Manual. </para> @@ -1465,7 +1465,7 @@ Using the <filename>--signoff</filename> option identifies you as the person making the change and also satisfies the Developer's Certificate of 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. See the earlier section "<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. When you provide the command, you must include a revision list or a number of patches as part of the command. - For example, these two commands each take the most recent single commit and - format it as an email message in the current directory: + For example, either of these two commands takes your most + recent single commit and formats it as an email message in + the current directory: <literallayout class='monospaced'> $ git format-patch -1 + </literallayout> + or + <literallayout class='monospaced'> $ git format-patch HEAD~ </literallayout></para> <para>After the command is run, the current directory contains a numbered <filename>.patch</filename> file for the commit.</para> <para>If you provide several commits as part of the command, - the <filename>git format-patch</filename> command produces a numbered - series of files in the current directory – one for each commit. + the <filename>git format-patch</filename> command produces a + series of numbered files in the current directory – one for each commit. If you have more than one patch, you should also use the <filename>--cover</filename> option with the command, which generates a cover letter as the first "patch" in the series. @@ -1520,7 +1524,9 @@ The command also has several options that let you specify recipients and perform further editing of the email message. 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> </para> </section> |