summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-newbie.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-11-10 13:28:32 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-11-25 15:24:17 +0000
commit39899b2212a5f21251004757d3c64055046fef11 (patch)
tree038dc7354f9430e5d7c689a959b02aa3150e3ec6 /documentation/dev-manual/dev-manual-newbie.xml
parent684c35b7aa0898f95ab70a5982ef74ce98107d93 (diff)
downloadpoky-39899b2212a5f21251004757d3c64055046fef11.tar.gz
documentation/dev-manual: Edits from Tom Zanussi.
Tom Zanussi provided a review up through part of the "model" chapter. I have implemented his comments mosty verbatim. Reported-by: Tom Zanussi (From yocto-docs rev: 693d4fadd4b34ffef9953fb1850d381ff7c028a3) 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.xml21
1 files changed, 17 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 54dd71a525..0efcbbb9b0 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -11,7 +11,7 @@
11 closed, proprietary environment. 11 closed, proprietary environment.
12 Additionally, the Yocto Project uses specific tools and constructs as part of its development 12 Additionally, the Yocto Project uses specific tools and constructs as part of its development
13 environment. 13 environment.
14 The chapter specifically addresses open source philosophy, licensing issues, code repositories, 14 This chapter specifically addresses open source philosophy, licensing issues, code repositories,
15 the open source distributed version control system Git, and best practices using the Yocto Project. 15 the open source distributed version control system Git, and best practices using the Yocto Project.
16</para> 16</para>
17 17
@@ -73,7 +73,7 @@
73 Conversely, if you are a developer that is not interested in contributing back to the 73 Conversely, if you are a developer that is not interested in contributing back to the
74 Yocto Project, you have the ability to simply download and extract release tarballs 74 Yocto Project, you have the ability to simply download and extract release tarballs
75 and use them within the Yocto Project environment. 75 and use them within the Yocto Project environment.
76 All that is required is a particular release of Yocto Project, a kernel, and 76 All that is required is a particular release of the Yocto Project and
77 your application source code. 77 your application source code.
78 </para> 78 </para>
79 79
@@ -599,7 +599,7 @@
599 </para> 599 </para>
600 600
601 <para> 601 <para>
602 Following is some guidance on which mailing list to use for what type of defect: 602 The following is some guidance on which mailing list to use for what type of defect:
603 <itemizedlist> 603 <itemizedlist>
604 <listitem><para>For defects against the Yocto Project build system Poky, send 604 <listitem><para>For defects against the Yocto Project build system Poky, send
605 your patch to the 605 your patch to the
@@ -778,6 +778,11 @@
778 <para>If you provide several commits as part of the command, 778 <para>If you provide several commits as part of the command,
779 the <filename>git format-patch</filename> command produces a numbered 779 the <filename>git format-patch</filename> command produces a numbered
780 series of files in the current directory – one for each commit. 780 series of files in the current directory – one for each commit.
781 If you have more than one patch, you should also use the
782 <filename>--cover</filename> option with the command, which generates a
783 cover letter as the first "patch" in the series.
784 You can then edit the cover letter to provide a description for
785 the series of patches.
781 For information on the <filename>git format-patch</filename> command, 786 For information on the <filename>git format-patch</filename> command,
782 see <filename>GIT_FORMAT_PATCH(1)</filename> displayed using the 787 see <filename>GIT_FORMAT_PATCH(1)</filename> displayed using the
783 <filename>man git-format-patch</filename> command.</para></listitem> 788 <filename>man git-format-patch</filename> command.</para></listitem>
@@ -790,7 +795,15 @@
790 or remote Mail Transport Agent (MTA) such as 795 or remote Mail Transport Agent (MTA) such as
791 <filename>msmtp</filename>, <filename>sendmail</filename>, or through a direct 796 <filename>msmtp</filename>, <filename>sendmail</filename>, or through a direct
792 <filename>smtp</filename> configuration in your Git <filename>config</filename> 797 <filename>smtp</filename> configuration in your Git <filename>config</filename>
793 file.</para> 798 file.
799 If you are submitting patches through email only, it is very important
800 that you submit them without any whitespace or HTML formatting that
801 either you or your mailer introduces.
802 The maintainer that receives your patches needs to be able to save and
803 apply them directly from your emails.
804 A good way to verify that what you are sending will be applicable by the
805 maintainer is to do a dry run and send them to yourself and then
806 save and apply them as the maintainer would.</para>
794 <para>The <filename>git send-email</filename> command is the preferred method 807 <para>The <filename>git send-email</filename> command is the preferred method
795 for sending your patches since there is no risk of compromising whitespace 808 for sending your patches since there is no risk of compromising whitespace
796 in the body of the message, which can occur when you use your own mail client. 809 in the body of the message, which can occur when you use your own mail client.