summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-07-31 08:37:54 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-08-02 10:00:25 +0100
commit73abcb0b161aba4e84fb8c2c99c88d18ed910878 (patch)
tree93d793e06f066dd0af00d540d2bad20a511f93ab /documentation/dev-manual
parent231fde5b1675f768ba616af5b90e9ef6016610ec (diff)
downloadpoky-73abcb0b161aba4e84fb8c2c99c88d18ed910878.tar.gz
dev-manual: Fixed up the list of other references.
There was a bogus link in there to the Build Appliance page. I also noted many links that use the <ulink> tag that crossed multiple lines. That is not good. I cleaned all that up. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: a39cea47cae29d7efb8e12495e8eefb484d464c4) 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')
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml83
1 files changed, 51 insertions, 32 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index 92d67e0d63..33239390bb 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -107,12 +107,16 @@
107 <itemizedlist> 107 <itemizedlist>
108 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: 108 <listitem><para><emphasis><ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>:
109 </emphasis> The home page for the Yocto Project provides lots of information on the project 109 </emphasis> The home page for the Yocto Project provides lots of information on the project
110 as well as links to software and documentation.</para></listitem> 110 as well as links to software and documentation.
111 </para></listitem>
111 <listitem><para><emphasis> 112 <listitem><para><emphasis>
112 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started 113 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis>
113 with the Yocto Project and quickly begin building an image.</para></listitem> 114 This short document lets you get started
115 with the Yocto Project and quickly begin building an image.
116 </para></listitem>
114 <listitem><para><emphasis> 117 <listitem><para><emphasis>
115 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference 118 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis>
119 This manual is a reference
116 guide to the OpenEmbedded build system, which is based on BitBake. 120 guide to the OpenEmbedded build system, which is based on BitBake.
117 The build system is sometimes referred to as "Poky". 121 The build system is sometimes referred to as "Poky".
118 </para></listitem> 122 </para></listitem>
@@ -120,11 +124,13 @@
120 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis> 124 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis>
121 This guide provides information that lets you get going with the Application 125 This guide provides information that lets you get going with the Application
122 Development Toolkit (ADT) and stand-alone cross-development toolchains to 126 Development Toolkit (ADT) and stand-alone cross-development toolchains to
123 develop projects using the Yocto Project.</para></listitem> 127 develop projects using the Yocto Project.
128 </para></listitem>
124 <listitem><para><emphasis> 129 <listitem><para><emphasis>
125 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> 130 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
126 This guide defines the structure for BSP components. 131 This guide defines the structure for BSP components.
127 Having a commonly understood structure encourages standardization.</para></listitem> 132 Having a commonly understood structure encourages standardization.
133 </para></listitem>
128 <listitem><para><emphasis> 134 <listitem><para><emphasis>
129 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis> 135 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis>
130 This manual describes how to work with Linux Yocto kernels as well as provides a bit 136 This manual describes how to work with Linux Yocto kernels as well as provides a bit
@@ -137,23 +143,28 @@
137 </para></listitem> 143 </para></listitem>
138 <listitem><para><emphasis> 144 <listitem><para><emphasis>
139 <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> 145 <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'>
140 Eclipse IDE Yocto Plug-in</ulink>:</emphasis> A step-by-step instructional video that 146 Eclipse IDE Yocto Plug-in</ulink>:</emphasis>
147 A step-by-step instructional video that
141 demonstrates how an application developer uses Yocto Plug-in features within 148 demonstrates how an application developer uses Yocto Plug-in features within
142 the Eclipse IDE.</para></listitem> 149 the Eclipse IDE.
150 </para></listitem>
143 <listitem><para><emphasis> 151 <listitem><para><emphasis>
144 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis> 152 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
145 A list of commonly asked questions and their answers.</para></listitem> 153 A list of commonly asked questions and their answers.
154 </para></listitem>
146 <listitem><para><emphasis> 155 <listitem><para><emphasis>
147 <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis> 156 <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
148 Features, updates and known issues for the current 157 Features, updates and known issues for the current
149 release of the Yocto Project.</para></listitem> 158 release of the Yocto Project.
159 </para></listitem>
150 <listitem><para><emphasis> 160 <listitem><para><emphasis>
151 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'> 161 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>:</emphasis>
152 Hob</ulink>:</emphasis> A graphical user interface for BitBake. 162 A graphical user interface for BitBake.
153 Hob's primary goal is to enable a user to perform common tasks more easily.</para></listitem> 163 Hob's primary goal is to enable a user to perform common tasks more easily.
164 </para></listitem>
154 <listitem><para><emphasis> 165 <listitem><para><emphasis>
155 <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'> 166 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/build-appliance'>Build Appliance</ulink>:</emphasis>
156 Build Appliance</ulink>:</emphasis> A virtual machine that 167 A virtual machine that
157 enables you to build and boot a custom embedded Linux image 168 enables you to build and boot a custom embedded Linux image
158 with the Yocto Project using a non-Linux development system. 169 with the Yocto Project using a non-Linux development system.
159 </para></listitem> 170 </para></listitem>
@@ -161,46 +172,54 @@
161 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis> 172 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
162 The bug tracking application the Yocto Project uses. 173 The bug tracking application the Yocto Project uses.
163 If you find problems with the Yocto Project, you should report them using this 174 If you find problems with the Yocto Project, you should report them using this
164 application.</para></listitem> 175 application.
165 <listitem><para><emphasis> 176 </para></listitem>
166 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing 177 <listitem><para><emphasis>Yocto Project Mailing Lists:</emphasis>
178 To subscribe to the Yocto Project mailing
167 lists, click on the following URLs and follow the instructions: 179 lists, click on the following URLs and follow the instructions:
168 <itemizedlist> 180 <itemizedlist>
169 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a 181 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink>
170 Yocto Project Discussions mailing list.</para></listitem> 182 for a Yocto Project Discussions mailing list.
171 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a 183 </para></listitem>
172 Yocto Project Discussions mailing list about the 184 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink>
185 for a Yocto Project Discussions mailing list about the
173 OpenEmbedded build system (Poky). 186 OpenEmbedded build system (Poky).
174 </para></listitem> 187 </para></listitem>
175 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> 188 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
176 for a mailing list to receive official Yocto Project announcements 189 for a mailing list to receive official Yocto Project announcements
177 as well as Yocto Project milestones.</para></listitem> 190 as well as Yocto Project milestones.
178 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a 191 </para></listitem>
179 listing of all public mailing lists on <filename>lists.yoctoproject.org</filename>. 192 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink>
193 for a listing of all public mailing lists on
194 <filename>lists.yoctoproject.org</filename>.
180 </para></listitem> 195 </para></listitem>
181 </itemizedlist></para></listitem> 196 </itemizedlist></para></listitem>
182 <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis> 197 <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
183 Two IRC channels on freenode are available 198 Two IRC channels on freenode are available
184 for Yocto Project and Poky discussions: <filename>#yocto</filename> and 199 for Yocto Project and Poky discussions: <filename>#yocto</filename> and
185 <filename>#poky</filename>, respectively.</para></listitem> 200 <filename>#poky</filename>, respectively.
201 </para></listitem>
186 <listitem><para><emphasis> 202 <listitem><para><emphasis>
187 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> 203 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
188 The build system used by the Yocto Project. 204 The build system used by the Yocto Project.
189 This project is the upstream, generic, embedded distribution 205 This project is the upstream, generic, embedded distribution
190 from which the Yocto Project derives its build system (Poky) 206 from which the Yocto Project derives its build system (Poky)
191 and to which it contributes.</para></listitem> 207 and to which it contributes.
208 </para></listitem>
192 <listitem><para><emphasis> 209 <listitem><para><emphasis>
193 <ulink url='http://www.openembedded.org/wiki/BitBake'> 210 <ulink url='http://www.openembedded.org/wiki/BitBake'>BitBake</ulink>:</emphasis>
194 BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system 211 The tool used by the OpenEmbedded build system
195 to process project metadata.</para></listitem> 212 to process project metadata.
213 </para></listitem>
196 <listitem><para><emphasis> 214 <listitem><para><emphasis>
197 <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis> 215 <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual:</ulink></emphasis>
198 A comprehensive guide to the BitBake tool. 216 A comprehensive guide to the BitBake tool.
199 If you want information on BitBake, see this manual. 217 If you want information on BitBake, see this manual.
200 </para></listitem> 218 </para></listitem>
201 <listitem><para><emphasis> 219 <listitem><para><emphasis>
202 <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>: 220 <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>:</emphasis>
203 </emphasis> An open-source machine emulator and virtualizer.</para></listitem> 221 An open-source machine emulator and virtualizer.
222 </para></listitem>
204 </itemizedlist> 223 </itemizedlist>
205 </para> 224 </para>
206 </section> 225 </section>