Commit Graph

268 Commits

Author SHA1 Message Date
Scott Rifenbark
cd1581bc16 ref-manual: Edits to rm_work class.
(From yocto-docs rev: 8085c14ee0d9706b410195b217b9470a7571ae53)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:24 +00:00
Scott Rifenbark
3623ba9ad0 ref-manual: Added systemd class and three variables:
Variables:
  SYSTEMD_PACKAGES
  SYSTEMD_SERVICE
  SYSTEMD_AUTO_ENABLE

(From yocto-docs rev: 8fd150085660a8697503131157e1a73e7996dc2d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:56 +00:00
Scott Rifenbark
c35962acfa ref-manual: Added syslinux class and many variables.
Variables added:
  AUTO_SYSLINUXMENU
  SYSLINUX_OPTS
  SYSLINUX_SPLASH
  SYSLINUX_DEFAULT_CONSOLE
  SYSLINUX_SERIAL
  SYSLINUX_SERIAL_TTY

(From yocto-docs rev: cb47fab2ba00617c8205b36a83b7e97f5504c5d9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:55 +00:00
Scott Rifenbark
39eaf3031f ref-manual: Added scons class and EXTRA_OESCONS variable.
(From yocto-docs rev: 463f9a6ee677033725756e7d5e9c3de3b445408d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:53 +00:00
Scott Rifenbark
12c1680986 ref-manual: Added qmake* class and three variables.
Variables:
  EXTRA_QMAKEVARS_POST
  EXTRA_QMAKEVARS_PRE
  QMAKE_PROFILES

(From yocto-docs rev: ea628091e32bad0397654bdbc003223a4aa150e6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:53 +00:00
Scott Rifenbark
4f2fb32c62 ref-manual: Added prserv class and PRSERV_HOST variable.
(From yocto-docs rev: f0195e750f1027146545ded2e7866bbc43b25d81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:51 +00:00
Scott Rifenbark
61edbfc616 ref-manual: Added populate_sdk_* class and some new variables.
Variables added:
  IMAGE_PKGTYPE
  SDK_OUTPUT
  SKD_DIR

(From yocto-docs rev: d33faa90cd2968f067dd74303660448b0a6acd3e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:50 +00:00
Scott Rifenbark
56429d3203 ref-manual: Added pixbufcache class and PIXBUF_PACKAGES variable.
(From yocto-docs rev: ed3ab4984b57608a7922e55c4d87401f9795352f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:49 +00:00
Scott Rifenbark
ccca482412 ref-manual: Added the ownmirrors class and the SOURCE_MIRROR_URL variable.
(From yocto-docs rev: 32c1d7aeecb6face0030def431b10277974f30d5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:18:46 +00:00
Scott Rifenbark
86c58a5375 ref-manual: Edits to license class added INHERIT_DISTRO variable.
(From yocto-docs rev: a3a4c62c489a262fdf484e0c38b86e7c65a08fcb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:38 +00:00
Scott Rifenbark
5f20fb847e ref-manual: Added image-live class and updated IMAGE_FSTYPES variable.
Added a note to the existing IMAGE_FSTYPES variable based on
using "live" as an image type.  Need to be sure that appears
before inherit line in the recipe.

(From yocto-docs rev: 1fc45b2bc7c70f00882d495d659830b94eb7d2df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:35 +00:00
Scott Rifenbark
223bfdc14d ref-manual: Placed the ICECC_CC variable as entry point for "I" variables.
(From yocto-docs rev: 071d47b1cd1e7d09c4ff34b4da799ae765980e65)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:34 +00:00
Scott Rifenbark
cd83080983 ref-manual: Added icecc class and several ICECC_* variables.
New variables added for:

  ICECC_CC
  ICECC_CXX
  ICECC_ENV_EXEC
  ICECC_PATH
  ICECC_USER_CLASS_BL
  ICECC_USER_PACKAGE_BL
  ICECC_USER_PACKAGE_WL
  ICECC_VERSION

(From yocto-docs rev: 264b0e8ce7d867edbdcbfbdc5621bcf087c13f58)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:34 +00:00
Scott Rifenbark
172cf55943 ref-manual: Edits to the GRUB_GFXSERIAL variable.
Told where to set this variable.

(From yocto-docs rev: f95fb5821383721da6a63bb8eb74807e89e6b21d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:33 +00:00
Scott Rifenbark
11c3ed6c64 ref-manual: Added the gtk-immodules-cache class and GTKIMMODULES_PACKAGES variable.
(From yocto-docs rev: 3bbec60f64e6a0b7cb3d42548f837466bec44312)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:33 +00:00
Scott Rifenbark
28a6b529c0 ref-manual: Added grub-efi class and supporting variables.
Created glossary entries for the GRUB_GFXSERIAL, LABELS,
APPEND, GRUB_OPTS, and GRUB_TIMEOUT variables.

(From yocto-docs rev: 31bcc25866525ef998bc01e11ab9ddb0601b8ded)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:32 +00:00
Scott Rifenbark
d2d4febc89 ref-manual: Added fontcache class and FONT_PACKAGES variable.
(From yocto-docs rev: 5d0cd87e45155236cd72b02267d5d081654bc2d3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:30 +00:00
Scott Rifenbark
37802407f8 ref-manual: Added extrausers class and EXTRA_USERS_PARAMS variable.
(From yocto-docs rev: 9638963d1eb7c4cf6d724b3633ac6410b13f6b2d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:30 +00:00
Scott Rifenbark
09ac6b52cd ref-manual: Added BUILDSTATS_BASE variable description.
(From yocto-docs rev: d95828c3fe6032f9aba5735a7fc703dcbdd21cef)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:26 +00:00
Scott Rifenbark
5f6fc88433 ref-manual: Added boot-directdisk class.
(From yocto-docs rev: c5644de8ffd3c3a1ee167fe6dfa62ac1ea1bf6be)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:25 +00:00
Scott Rifenbark
ace0b23d0a ref-manual: Added ROOTFS, NOHDD, and NOISO variable descriptions.
(From yocto-docs rev: a8cf267cf94d9e144c1b12ca6e7fa4208377fe7c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:25 +00:00
Scott Rifenbark
74df25fafc ref-manual: Added INITRD variable to the glossary.
(From yocto-docs rev: 02a2426dd9d0525c242088a7a43322de61b46ac5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:24 +00:00
Scott Rifenbark
ff7f5da85e ref-manual: Added PNBLACKLIST variable to the glossary.
(From yocto-docs rev: 57edd99d78d00d5b321129483b3a56b57495a503)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:24 +00:00
Trevor Woerner
0922d3c603 ref-manual: add usage NOTE to IMAGE_FSTYPES
Due to the way in which IMAGE_FSTYPES is processed, it is not possible to
modify it using _append or _prepend. Therefore add a note to the manual to
warn users in case they stumble on this issue.

(From yocto-docs rev: 164aee65a6796ccc24c2734bb7440a8d6531f180)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:22 +00:00
Scott Rifenbark
8275b929ec ref-manual: Updates and additions to variable glossary:
I applied some review edits to the USERADD_PACKAGES and
USERADD_PARAM variables from Paul.  Additionally, I added descriptions
for the GROUPADD_PARAM and GROUPMEMS_PARAM variables.

(From yocto-docs rev: 0c52a79efb2cf7c708ea989ab307be04f27484dc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:19 +00:00
Scott Rifenbark
4f7c36639c ref-manual: Added new REQUIRED_DISTRO_FEATURES variable description.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 4eb9a5c6df085e57e7885e12fdbdcc85f61c101d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:19 +00:00
Scott Rifenbark
acf9a04a38 ref-manual: Added new CONFLICT_DISTRO_FEATURES variable description.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 6ace08dcbaa08fd13d4d8f49d34dd90240e65761)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:18 +00:00
Scott Rifenbark
3cd9b7e1ac ref-manual: Edits to the COMBINED_FEATURES variable.
(From yocto-docs rev: 13405652b9a170960f15bd30a0c335df25e8b294)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:18 +00:00
Scott Rifenbark
bbd193d86c ref-manual: Some edits to the DISTRO_FEATURES variable.
(From yocto-docs rev: 08e86f0b5bad77f0b01508cc5343027541c3b433)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:17 +00:00
Scott Rifenbark
7496f805e3 ref-manual: Updated the DISTRO variable description.
This needed some work to be more descriptive.

(From yocto-docs rev: 2ea324c84f5aaaf3c30d1c71396fa3d5372669a0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:17 +00:00
Scott Rifenbark
63de643f65 ref-manual: Edits to the DISTRO_FEATURES variable.
Took care of some quoting for the "x11" feature and also a
messed up sentence in the second paragraph.

(From yocto-docs rev: ed71135edbdd8de02cbb6d7cc972aab0e269e4cb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:17 +00:00
Scott Rifenbark
d85638820b dev-manual, ref-manual: Updated some section titles.
I noticed that chapter 10 of the ref-manual still had
"Reference: Features" as the title.  This is left over from way
back.  I changed that chapter title to "Features."  Next, I
noticed an inconsistency with some sub-section titles.
I changed the "Images" title into "Image Features."  This affected
several links across the doc set so I had to update those
cross-references as well so they have the latest section title
as part of the reference.

(From yocto-docs rev: b68f009a92e0e24802e367d98cf66e15ba1cd364)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:16 +00:00
Scott Rifenbark
936cc69a89 ref-manual: Cleaned up some instances of the term "working directory"
This term should always reference a users current working directory
and not be confused with the OpenEmbedded build system's "work
directory (WORKDIR).  I found several instances where the term
"working directory" was not used correctly and fixed them.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 300c78c1d54b2a4fbb8ecca03faa7c8c67bdc54f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:15 +00:00
Scott Rifenbark
89fc8b84b7 ref-manual: Updated to *_FEATURES variables.
I updated the MACHINE_FEATURES, DISTRO_FEATURES, and
COMBINED_FEATURES variable descriptions to better reflect what
they actually do.  Also, fixed two occurences of IrDA in the
features lists section.

(From yocto-docs rev: af79b0b3bc88ca0811d488c7c5d6b5407de808a7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:15 +00:00
Scott Rifenbark
b2d0ff180d ref-manual: Review edits applied to UBOOT_LOCALVERSION variable.
(From yocto-docs rev: 2cff8d929461ce2de60aa083f8a4a8640df642ce)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:15 +00:00
Scott Rifenbark
341a685c9a ref-manual: Edits to the UBOOT_LOCALVERSION variable.
(From yocto-docs rev: 856cc1ff0fa70ca28536374b0a3a426438f701e3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:14 +00:00
Scott Rifenbark
a880e6bb53 ref-manual: Fixed typo in the UBOOT_CONFIG variable.
(From yocto-docs rev: 5b037c8caad6b597e7f90f056113fe0da2093e7d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:14 +00:00
Scott Rifenbark
e6df367375 ref-manual: Added new variable UBOOT_MAKE_TARGET.
(From yocto-docs rev: a2f3e293961cd611220d22b6105ef31046939f3c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:14 +00:00
Scott Rifenbark
a729e89ce7 ref-manual: Added new UBOOT_SUFFIX variable description.
(From yocto-docs rev: e7a4899dc49a125195a5675693443a352eb82dca)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:13 +00:00
Scott Rifenbark
412abaeadf ref-manual: Added new variable UBOOT_LOCALDEFINITION
Very rough draft for this new variable.  It will likely
change.

(From yocto-docs rev: b535542975ae469753cb27ce59f9f716167384fb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:13 +00:00
Scott Rifenbark
ab4f352163 ref-manual: Fixed misc. formatting by removing blank lines.
(From yocto-docs rev: 1bce1112ffa1f2c90bd99c5da2defb95aaa3a955)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:13 +00:00
Scott Rifenbark
a18b4e339e ref-manual: Fixed typo.
(From yocto-docs rev: 6539134377ab0e59ef968cb90f24732dd942c403)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:13 +00:00
Scott Rifenbark
f99c70ca1e ref-manual: Reset the top "U" entry for glossary to UBOOT_CONFIG.
(From yocto-docs rev: d50935afe4a4f6469d19d3492737b128a8ddd7af)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:12 +00:00
Scott Rifenbark
a16e9a20b5 ref-manual: Added glossary entry for UBOOT_CONFIG variable.
(From yocto-docs rev: 24d9c5141e4c7c832f74f088c758f966c52b992c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:12 +00:00
Scott Rifenbark
96b948af5f ref-manual: Expanded CLASSOVERRIDE variable example description.
(From yocto-docs rev: d393de9d80e533cf6ed89d967c21b5edb96cafd9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:12 +00:00
Scott Rifenbark
c95eca61da ref-manual: New glossary entries
I added glossary definitions for BUGTRACKER and
CLASSOVERRIDE.

(From yocto-docs rev: 79c10f1cf0f18429eb41b035ed60264b48549e9a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:10 +00:00
Scott Rifenbark
cac929e648 ref-manual: Added other argument values to set variable
The BB_DANGLINGAPPENDS_WARNONLY variable seems to be able
to be set using "1", "yes", and "true".  And, it is set using
these various methods throughout the poky metadata.  I guess it
has caused a bit of confusion so I have added the fact to the
description.

Reporte-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 651e09aba67f9d62ce005529f16a776c0ab593f1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:10 +00:00
Scott Rifenbark
dd6b2ef9e7 documentation: Scrubbed use of directory names
There was inconsistent use of the way directory names were
handled throughout the YP documentation.  I have scrubbed the
set and replaced many instances such as the following:

meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)

I basically got rid of leading slash characters.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:06 +00:00
Scott Rifenbark
1c19d66653 ref-manual: Updates to the FEED_DEPLOYDIR_BASE_URI variable.
Fixes [YOCTO #5408]

Some edits to remove a link to the YP Metadata definition.
The metadata referred to here is for opkg only.

(From yocto-docs rev: 777969fb3b74e638fedb638d161e2f92ac0a5f4c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:03 +00:00
Scott Rifenbark
81a7812a97 ref-manual: Added FEED_DEPLOYDIR_BASE_URI variable description
Fixes [YOCTO #5408]

As part of the fix for this bug, I have added a description of this
variable to the glossary.

(From yocto-docs rev: ad988c82b364bb0c629bcb2ce04f99e0e371622e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:03 +00:00