summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-09-30 14:24:22 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-03 14:41:29 +0100
commite90f4a13603a30f26cf58ed56a1f645fdef1bfe6 (patch)
tree2cc51df026b38bc9693b0f8a2d2a46ae417c8ca3 /documentation
parent0389b3b7e8004373320689750ecf877ae5cc6da9 (diff)
downloadpoky-e90f4a13603a30f26cf58ed56a1f645fdef1bfe6.tar.gz
ref-manual: Minor edits to "Image Features" section.
Reversed order of the list presentation and re-worded the static library sentence. (From yocto-docs rev: 5c32730550629527f6ceb2140df31a097f7a6081) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-features.xml106
1 files changed, 52 insertions, 54 deletions
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml
index 174f44f3e7..c216ded866 100644
--- a/documentation/ref-manual/ref-features.xml
+++ b/documentation/ref-manual/ref-features.xml
@@ -220,10 +220,61 @@
220 </para> 220 </para>
221 221
222 <para> 222 <para>
223 The following image features are available for all images:
224 <itemizedlist>
225 <listitem><para><emphasis>dbg-pkgs:</emphasis>
226 Installs debug symbol packages for all packages installed
227 in a given image.
228 </para></listitem>
229 <listitem><para><emphasis>debug-tweaks:</emphasis>
230 Makes an image suitable for development (e.g.
231 allows root logins without passwords).
232 </para></listitem>
233 <listitem><para><emphasis>dev-pkgs:</emphasis>
234 Installs development packages (headers and extra library
235 links) for all packages installed in a given image.
236 </para></listitem>
237 <listitem><para><emphasis>doc-pkgs:</emphasis> Installs
238 documentation packages for all packages installed in a
239 given image.
240 </para></listitem>
241 <listitem><para><emphasis>package-management:</emphasis>
242 Installs package management tools and preserves the package
243 manager database.
244 </para></listitem>
245 <listitem><para><emphasis>ptest-pkgs:</emphasis>
246 Installs ptest packages for all ptest-enabled recipes.
247 </para></listitem>
248 <listitem><para><emphasis>read-only-rootfs:</emphasis>
249 Creates an image whose root filesystem is read-only.
250 See the
251 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
252 section in the Yocto Project Development Manual for more
253 information.
254 </para></listitem>
255 <listitem><para><emphasis>splash:</emphasis>
256 Enables showing a splash screen during boot.
257 By default, this screen is provided by
258 <filename>psplash</filename>, which does allow
259 customization.
260 If you prefer to use an alternative splash screen package,
261 you can do so by setting the <filename>SPLASH</filename>
262 variable to a different package name (or names) within the
263 image recipe or at the distro configuration level.
264 </para></listitem>
265 <listitem><para><emphasis>staticdev-pkgs:</emphasis>
266 Installs static development packages, which are
267 static libraries (e.g. <filename>*.a</filename> files), for
268 all packages installed in a given image.
269 </para></listitem>
270 </itemizedlist>
271 </para>
272
273 <para>
223 Some image features are available only when you inherit the 274 Some image features are available only when you inherit the
224 <link linkend='ref-classes-core-image'><filename>core-image</filename></link> 275 <link linkend='ref-classes-core-image'><filename>core-image</filename></link>
225 class. 276 class.
226 The current list of these valid variables is as follows: 277 The current list of these valid features is as follows:
227 <itemizedlist> 278 <itemizedlist>
228 <listitem><para><emphasis>eclipse-debug:</emphasis> Provides 279 <listitem><para><emphasis>eclipse-debug:</emphasis> Provides
229 Eclipse remote debugging support. 280 Eclipse remote debugging support.
@@ -284,59 +335,6 @@
284 </itemizedlist> 335 </itemizedlist>
285 </para> 336 </para>
286 337
287 <para>
288 Other image features are available for all images regardless of
289 whether or not you inherit the <filename>core-image</filename>
290 class.
291 The list of these valid variables is as follows:
292 <itemizedlist>
293 <listitem><para><emphasis>dbg-pkgs:</emphasis>
294 Installs debug symbol packages for all packages installed
295 in a given image.
296 </para></listitem>
297 <listitem><para><emphasis>debug-tweaks:</emphasis>
298 Makes an image suitable for development (e.g.
299 allows root logins without passwords).
300 </para></listitem>
301 <listitem><para><emphasis>dev-pkgs:</emphasis>
302 Installs development packages (headers and extra library
303 links) for all packages installed in a given image.
304 </para></listitem>
305 <listitem><para><emphasis>doc-pkgs:</emphasis> Installs
306 documentation packages for all packages installed in a
307 given image.
308 </para></listitem>
309 <listitem><para><emphasis>package-management:</emphasis>
310 Installs package management tools and preserves the package
311 manager database.
312 </para></listitem>
313 <listitem><para><emphasis>ptest-pkgs:</emphasis>
314 Installs ptest packages for all ptest-enabled recipes.
315 </para></listitem>
316 <listitem><para><emphasis>read-only-rootfs:</emphasis>
317 Creates an image whose root filesystem is read-only.
318 See the
319 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
320 section in the Yocto Project Development Manual for more
321 information.
322 </para></listitem>
323 <listitem><para><emphasis>splash:</emphasis>
324 Enables showing a splash screen during boot.
325 By default, this screen is provided by
326 <filename>psplash</filename>, which does allow
327 customization.
328 If you prefer to use an alternative splash screen package,
329 you can do so by setting the <filename>SPLASH</filename>
330 variable to a different package name (or names) within the
331 image recipe or at the distro configuration level.
332 </para></listitem>
333 <listitem><para><emphasis>staticdev-pkgs:</emphasis>
334 Installs static development packages (i.e. static
335 libraries containing <filename>*.a</filename> files) for
336 all packages installed in a given image.
337 </para></listitem>
338 </itemizedlist>
339 </para>
340 </section> 338 </section>
341 339
342 <section id='ref-features-backfill'> 340 <section id='ref-features-backfill'>