summaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml6
-rw-r--r--documentation/dev-manual/dev-manual-model.xml10
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml21
-rw-r--r--documentation/dev-manual/dev-manual-start.xml6
4 files changed, 28 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index 85eea519ff..da6abd4b08 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -35,7 +35,7 @@
35 <itemizedlist> 35 <itemizedlist>
36 <listitem><para>Information that lets you get set 36 <listitem><para>Information that lets you get set
37 up to develop using the Yocto Project.</para></listitem> 37 up to develop using the Yocto Project.</para></listitem>
38 <listitem><para>Information to help developers that are new to the open source environment 38 <listitem><para>Information to help developers who are new to the open source environment
39 and to the distributed revision control system Git, which the Yocto Project 39 and to the distributed revision control system Git, which the Yocto Project
40 uses.</para></listitem> 40 uses.</para></listitem>
41 <listitem><para>An understanding of common end-to-end development models.</para></listitem> 41 <listitem><para>An understanding of common end-to-end development models.</para></listitem>
@@ -63,7 +63,7 @@
63 <itemizedlist> 63 <itemizedlist>
64 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto 64 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto
65 Project documentation. 65 Project documentation.
66 For example, The Application Development Toolkit (ADT) User’s Guide contains detailed 66 For example, the Application Development Toolkit (ADT) User’s Guide contains detailed
67 instruction on how to obtain and configure the 67 instruction on how to obtain and configure the
68 <trademark class='trade'>Eclipse</trademark> Yocto Plug-in.</para></listitem> 68 <trademark class='trade'>Eclipse</trademark> Yocto Plug-in.</para></listitem>
69 <listitem><para>Reference material. 69 <listitem><para>Reference material.
@@ -153,7 +153,7 @@
153 OpenedHand has since been acquired by Intel Corporation.</para></listitem> 153 OpenedHand has since been acquired by Intel Corporation.</para></listitem>
154 <listitem><para><emphasis> 154 <listitem><para><emphasis>
155 <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> 155 <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis>
156 The company who acquired OpenedHand in 2008 and continues development on the 156 The company that acquired OpenedHand in 2008 and continues development on the
157 Yocto Project.</para></listitem> 157 Yocto Project.</para></listitem>
158 <listitem><para><emphasis> 158 <listitem><para><emphasis>
159 <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis> 159 <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis>
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index f2912b1c1b..296c59bcde 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -51,7 +51,7 @@
51 51
52 <para> 52 <para>
53 A BSP is a package of recipes that, when applied, during a build results in 53 A BSP is a package of recipes that, when applied, during a build results in
54 an image you can run on a particular board. 54 an image that you can run on a particular board.
55 Thus, the package, when compiled into the new image, supports the operation of the board. 55 Thus, the package, when compiled into the new image, supports the operation of the board.
56 </para> 56 </para>
57 57
@@ -61,8 +61,8 @@
61 </note> 61 </note>
62 62
63 <para> 63 <para>
64 The remainder of this section presents the basic steps to create a BSP basing it on an 64 The remainder of this section presents the basic steps used to create a BSP
65 existing BSP that ships with the Yocto Project. 65 based on an existing BSP that ships with the Yocto Project.
66 You can reference the "<link linkend='dev-manual-bsp-appendix'>BSP Development Example</link>" 66 You can reference the "<link linkend='dev-manual-bsp-appendix'>BSP Development Example</link>"
67 appendix for a detailed example that uses the Crown Bay BSP as a base BSP from which to start. 67 appendix for a detailed example that uses the Crown Bay BSP as a base BSP from which to start.
68 </para> 68 </para>
@@ -85,12 +85,12 @@
85 <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your 85 <listitem><para><emphasis>Establish a local copy of the Yocto Project files on your
86 system</emphasis>: You need to have the Yocto Project files available on your host system. 86 system</emphasis>: You need to have the Yocto Project files available on your host system.
87 Having the Yocto Project files on your system gives you access to the build 87 Having the Yocto Project files on your system gives you access to the build
88 process and tools you need. 88 process and to the tools you need.
89 For information on how to get these files, see the 89 For information on how to get these files, see the
90 "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem> 90 "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem>
91 <listitem><para><emphasis>Establish a local copy of the base BSP files</emphasis>: Having 91 <listitem><para><emphasis>Establish a local copy of the base BSP files</emphasis>: Having
92 the BSP files on your system gives you access to the build 92 the BSP files on your system gives you access to the build
93 process and tools you need for creating a BSP. 93 process and to the tools you need for creating a BSP.
94 For information on how to get these files, see the 94 For information on how to get these files, see the
95 "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem> 95 "<link linkend='getting-setup'>Getting Setup</link>" section.</para></listitem>
96 <listitem><para><emphasis>Choose a Yocto Project-supported BSP as your base BSP</emphasis>: 96 <listitem><para><emphasis>Choose a Yocto Project-supported BSP as your base BSP</emphasis>:
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.
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index df1d59fe79..2a93ec6f67 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -43,7 +43,7 @@
43</section> 43</section>
44 44
45<section id='getting-setup'> 45<section id='getting-setup'>
46 <title>Getting Setup</title> 46 <title>Getting Set Up</title>
47 47
48 <para> 48 <para>
49 Here is what you need to get set up to use the Yocto Project: 49 Here is what you need to get set up to use the Yocto Project:
@@ -141,8 +141,8 @@
141 Checking out files: 100% (36898/36898), done. </literallayout></para></listitem> 141 Checking out files: 100% (36898/36898), done. </literallayout></para></listitem>
142 <listitem id='poky-extras-repo'><para><emphasis> 142 <listitem id='poky-extras-repo'><para><emphasis>
143 The <filename>poky-extras</filename> Git Repository</emphasis>: 143 The <filename>poky-extras</filename> Git Repository</emphasis>:
144 The <filename>poky-extras</filename> Git repository contains metadata needed to 144 The <filename>poky-extras</filename> Git repository contains metadata needed
145 build the kernel image. 145 only if you are modifying and building the kernel image.
146 In particular, it contains the kernel <filename>.bbappend</filename> files that you 146 In particular, it contains the kernel <filename>.bbappend</filename> files that you
147 edit to point to your locally modified kernel source files and to build the kernel 147 edit to point to your locally modified kernel source files and to build the kernel
148 image. 148 image.