Commit Graph

294 Commits

Author SHA1 Message Date
Scott Rifenbark d4a245824c ref-manual: Updated the bootimg class description.
Found some poor writing in this description.

(From yocto-docs rev: f54810d68a5efb25c102cd99a7e2b9cfcf7ad7de)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:15 +01:00
Scott Rifenbark 20c1cc0833 ref-manual: Removed archive* class and replaced with archiver class.
The set of archive* classes has been removed leaving only the
archiver.bbclass.

(From yocto-docs rev: 1660896b47ff5d21ae73d383505063f1c7c1a3b1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:14 +01:00
Scott Rifenbark 0ff499a627 ref-manual: Edits to the copyleft_compliance class.
I updated the referencing to adjust to the emergence of the
archiver.bbclass and disappearance of the archive* classes.

(From yocto-docs rev: 903e9b7c534e65e1be3eb0dc57378e120c7a0e3e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:14 +01:00
Scott Rifenbark 4644a8833b ref-manual: Edits to distutils3 and setuptools3 class descriptions.
(From yocto-docs rev: 1be2bbfcfc9b4f3c2d32fb210fe815b1fe99eda1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:14 +01:00
Scott Rifenbark 6c8b19b926 ref-manual: Added setuptools3 class description.
(From yocto-docs rev: 3953f96224bb6a0e5e528d5230bc6706149dc52c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:14 +01:00
Scott Rifenbark 60041e0cfb ref-manual: Added distutils3 class.
(From yocto-docs rev: 0962f3545ea7c97f821355e36bf6aa85fea8b392)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:14 +01:00
Scott Rifenbark 5d6dcdb837 dev-manual, ref-manual: Added notes for Systemd-based images.
Fixes [YOCTO #5159]

In the dev-manual, I located instances where a note about using
VIRTURAL-RUNTIME_initscripts = "" in the local.conf file would
be appropriate.  Three areas updated.

In the ref-manual, I located the note in the systemd.bbclass
section and the variable descriptions for SYSTEM_AUTO_ENABLE,
SYSTEM_PACKAGES, and SYSTEMD_SERVICE.

(From yocto-docs rev: 57b0acf2f3f8159b635b42dcffa129f7d945eb81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-04 15:20:17 +01:00
Scott Rifenbark f1e9e335ee dev-manual, ref-manual: Added error reporting tool information
Fixes [YOCTO #1562]

In the dev-manual, I created a new section called "Using the
Error Reporting Tool" that describes how to use this feature.
The text was based on information I received from Andreea Proca.

In the ref-manual, I added a new variable entry for ERR_REPORT_DIR
in the glossary and a new report-error class in the class chapter.

(From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:18:37 +01:00
Scott Rifenbark 0977097cd8 ref-manual: Fixing whitespace.
(From yocto-docs rev: 5ab12447d14ca7054ae44283ec858464c9b04244)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:45 +00:00
Scott Rifenbark 32890f29af adt-manual, ref-manual: Cross-toolchain details added. New class also.
In the adt-manual in the "Optionally Building a Toolchain Installer"
setion, I added some basic advantage information for building a
toolchain installer using bitbake image -c populate_sdk.

In the ref-manual, I added cross-referencing to this basic information
in several strategic areas: "SDK Generation", the populate_sdk class
reference section, the populate_sdk_* class reference section, and the
"Cross-Development Toolchain Generation" sections.

Finally, I also put in documentation for a new class called
autotools-brokensep.

(From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:44 +00:00
Scott Rifenbark 29b2fb6d77 ref-manual: Updated the nativesdk class to have correct class.
(From yocto-docs rev: 8e0a3c236f746caa6263038380144957039feabe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-21 21:58:03 +00:00
Scott Rifenbark 350aeebec4 ref-manual: Updated native and nativesdk classes.
Added a bit about needing to place the inherit statement last.

(From yocto-docs rev: 204e15035a9a116002b7f645e4edb378979c89f6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-21 21:58:03 +00:00
Scott Rifenbark 6a2456a3ab ref-manual: Fixed cross-reference anchor name.
(From yocto-docs rev: 06f429d986c02a1b4d7b324e34c2434da0e9e9af)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-21 21:58:00 +00:00
Scott Rifenbark 61597c48ee ref-manual: Edits to the icecc class.
Added some more information around the use of the ICECC_DISABLED
variable.  Information from Martin.

Reported-by: Martin Jansa <martin.jansa@gmail.com>
(From yocto-docs rev: 25990dbe66690991babda602ef40df948b70b038)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-02 13:16:09 +00:00
Scott Rifenbark 8275e0f725 ref-manual: Fixed the reference to the script for icecc class.
(From yocto-docs rev: 0f3f134fe8292d6b1e6665c80d9e13a80c6c8326)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-13 16:30:02 +00:00
Scott Rifenbark f9321630a6 ref-manual: Added module and module-base classes.
(From yocto-docs rev: d815e0fd2f49c5269432427f08b88657c4e50104)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-13 16:30:01 +00:00
Scott Rifenbark 954872643c ref-manual: Edits to gnomebase class.
Review comments from Ross.

(From yocto-docs rev: 66b96ff713548710716a61f9da4a53b1cf37d78c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:41 +00:00
Scott Rifenbark 0091385f3f ref-manual: Edits to setuptools class.
Review edits from Paul.

(From yocto-docs rev: b60ea90236a614eb4ab3a1604383ae7161e0e8e5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:40 +00:00
Scott Rifenbark 26556a0a99 ref-manual: Minor edits to rootfs* class.
Review comments from Paul.

(From yocto-docs rev: f931a4c6cea86a3dbbf27204731857a384ad0ea1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:40 +00:00
Scott Rifenbark caf0dd0c61 ref-manual: Added more info to distrodata class.
Saul Wold provided me with more detail on this class, which
I added.

(From yocto-docs rev: eee81ed69fc6ba766926f8514e88df4ba4640cec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:39 +00:00
Scott Rifenbark b080c99112 ref-manual: Added more info to gnomebase class.
Ross Burton provided an expanded explanation.

(From yocto-docs rev: 313899b280d7879ee86c9317021388a3cd080662)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:39 +00:00
Scott Rifenbark 1762d18692 ref-manual: Edits to the icecc class.
The text used "packages" rather than "recipes."  This is a
tragic result of historical naming mistakes early in the project.

(From yocto-docs rev: 0492b458f249f0c4cec6fa3cdd73ab7ca1f1506e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:37 +00:00
Scott Rifenbark 16626c386c ref-manual: Edits to the terminal class.
(From yocto-docs rev: 73aeb95760845dc9d09277828ec66caa7e13ca8b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:36 +00:00
Scott Rifenbark 483fc4864b ref-manual: Edits to the systemd class.
Removed the formatting of the second instance of the
term "systemd".

(From yocto-docs rev: 46696db9869318d8df026a2761d6d8c70e7b3b55)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:36 +00:00
Scott Rifenbark 7853e3b445 ref-manual: Edits to the setuptools class.
Some minor re-wordings here.

(From yocto-docs rev: 4f60a44520263e3ef3c885a27fcaba1ef8b63609)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:35 +00:00
Scott Rifenbark 6e91d5d201 ref-manual: Edits to the rootfs* class.
I removed the rootfs_deb, rootfs_ipk, and rootfs_rpm classes
altoghther and opted to briefly describe their purposes in the
rootfs* class section.  I also am not linking to the IMAGE_FSTYPES
variable but am rather linking over to the PACKAGE_CLASSES
variable.

(From yocto-docs rev: 5e92a1d4f489d5b48f5dbaac7c75ab1a1014e220)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:35 +00:00
Scott Rifenbark d76301b47f ref-manual: Edits to pixbufcache and pythonnative classes.
(From yocto-docs rev: d61ea64ba81752243ba900406f30813339b11801)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:35 +00:00
Scott Rifenbark 4e83d80b90 ref-manual: Edits to the package_tar class.
Turns out you can specify this using the PACKAGE_CLASSES
variable but you better not list it first.

(From yocto-docs rev: 9b160b15b3508e360fd57ac4375867d58cdc9709)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:34 +00:00
Scott Rifenbark b361db0868 ref-manual: Edits to icecc class and removal of three variables.
Fixed the links in the icecc class that linked into ICECC_CC,
ICECC_CXX, and ICECC_VERSION so they don't link anymore but rather
give a very brief explanation of what the variable does.

Removed the above three variables from the variable glossary.
These are not BitBake variables and we should not document them.

(From yocto-docs rev: f4f79d27c0d1417ff683381f18f165cda3a8a02e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:31 +00:00
Scott Rifenbark 348cec5ebb ref-manual: Added some references to variables in the useradd class.
Added links to USERADD_PACKAGES, USERADD_PARAM, GROUPADD_PARAM,
and GROUPMEMS_PARAM

(From yocto-docs rev: 4b9d23c205f687a6c43efd9f504a7cc9815dc835)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:30 +00:00
Scott Rifenbark b972f4b430 ref-manual: Review edits from "I" through "Z" classes.
icecc - added link to Icecream.

images - added some reference links to the end of the section.

logging - added closing ")" character.

nativesdk - corrected the mis-copied recipe name.

own-mirrors - fixed the class name so it was not "ownmirrors".

package - minor tweak to indicate class. Also spelled Berkeley
          correctly.

package_deb, package_ipk, and package_rpm - dumped a note and
         mentioned that you need PACKAGE_CLASSES to enable the
         class.

package_tar - noted that the recipe inheriting the tar class is what
         does the trick here.

pixbufcache - minor edits

populate_sdk - minor edits

prserv - edits to tell how it is enabled.

pythonnative - re-worded it.

rootfs* - reworded.

rootfs_deb, rootfs_ipk, and rootfs_rpm - Brand new.

systemd - reworded.

terminal - rewording

useradd - reworded

(From yocto-docs rev: a668eb6e70f416c0818253b0d3456c4f5f6ec050)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:30 +00:00
Scott Rifenbark 3b17557e51 ref-manual: Changed Gobject to GObject.
(From yocto-docs rev: 8af7ff9ff4bff2bfb3619f298be33c3e0b3e68de)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:29 +00:00
Scott Rifenbark a6f4ea77bf ref-manual: Edits to classes "I" through "K"
Added opening reason for the icecc class. Also cleared up the
sentence describing ICECC_PATH.

Minor fix to image class. Also added some reference
links.

Minor fix to image-mklibs class.  Also combined rouge
sentence stating that the class in enabled.

Same fix to rogue sentence in image-prelink class.

Fixed "insserve" into "insserv" throughout.

Added many links to some missing classes in the kernel
class.  Subsequent commit to actually add the class
documentation.

(From yocto-docs rev: 150de3e52d6c8c775b1128118e7d6eff51014c4e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:29 +00:00
Scott Rifenbark 3a9d7760f8 ref-manual: Review edits to classes "E" through "G"
extrausers - Changed the note to try and describe that the
  change is still specific to an image recipe but is not
  tied to other individual recipes.

fontcache - Minor fix.

gtk-icon-cache - fixed capitalization issue.

gtk-immodules-cache - Minor fix

gzipnative - Minor fix.

(From yocto-docs rev: 8cf810bf7b1c030c831205526303af7dd73cf6be)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:29 +00:00
Scott Rifenbark 644fdc4155 ref-manual: Edits to bugzilla and deploy class.
Fixed a link in the deploy class.
Re-wrote the bugzilla class to be clearer.

(From yocto-docs rev: 4bb975a0e12c9d38e941f1cf913c042498f06976)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:28 +00:00
Scott Rifenbark 55a5058059 ref-manual: Review edits to the "C" and "D" classes.
Modifications to ccache, chrpath, clutter, cross, cross-canadian,
crosssdk, and debian classes.

Added a new variable to the glossary for LEAD_SONAME.

(From yocto-docs rev: f27b6315f839a731017866106578e664c6c86982)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:28 +00:00
Scott Rifenbark bc6b005b0c ref-manual: Review edits to classes A through B
Applied some review edits from Paul Eggleton for the following
classes:

  allarch
  base
  bin_package
  bugzilla
  buildstats

(From yocto-docs rev: fe6b688106c5444fe6306326751ce636894acfd3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:28 +00:00
Scott Rifenbark 6b58ab391b ref-manual: Scrubbed the comment list of undocumented classes.
(From yocto-docs rev: cccaeea50a75f9f532680c4f0fbf35621ae3bef3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:27 +00:00
Scott Rifenbark 113077b95d ref-manual: Removed the section "Other Classes"
This section was there because we did not document all the
classes in meta/classes.  Now that we are I am dumping it.

(From yocto-docs rev: 3c704fcf8b9e6684d40f0df2069c4e17989ad129)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:27 +00:00
Scott Rifenbark 79ba3e4561 ref-manual: Re-ordered externalsrc class into the "C"'s
(From yocto-docs rev: 4b655fbc4abd9ae4a6280346b057b54e99be9d84)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:27 +00:00
Scott Rifenbark de7ead9cfd ref-manual: Edits to externalsrc class.
(From yocto-docs rev: 910cd04897a3d9dc140b71e73c1d48ce262b274e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:27 +00:00
Scott Rifenbark 36a9f7ef91 ref-manual: Edits to useradd class.
(From yocto-docs rev: ca7cfe44453aa94ddb00b57cf3f87d6eaacb4c25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:26 +00:00
Scott Rifenbark 1411329d97 ref-manual: Edits to update-rc.d class.
(From yocto-docs rev: 90dfbd18040986776a021e6a0fd56b9178a13048)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:26 +00:00
Scott Rifenbark 76a5d86e25 ref-manual: Edits to update-alternatives class.
Also had to update four instances in the variables glossary where
links to the section for the class became misnamed due to
stripping out the excess stuff from the class section heading.

(From yocto-docs rev: d98d3848327950c5c5cfc8559379e56c97157ad2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:26 +00:00
Scott Rifenbark 58e3323caf ref-manual: Re-ordered the classes that start with "U"
(From yocto-docs rev: 9a44ff391521f039a6c42ddb9fb9c97aefcd2c35)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:25 +00:00
Scott Rifenbark 759c88f778 ref-manual: Edits to testimage class.
(From yocto-docs rev: 3fac6693a78cf9242a600c5f6c68175595531f84)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:25 +00:00
Scott Rifenbark 73ddfa2ab0 ref-manual: Re-ordered classes that start with "T"
(From yocto-docs rev: 832e391cc7fab66db3be0b8ba4235d7bf59fb33b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:25 +00:00
Scott Rifenbark b43c26ff6c ref-manual: Edits to siteinfo class.
(From yocto-docs rev: f66f7849b8ac338521c0890872e91e421cb25422)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-11 14:19:25 +00:00
Scott Rifenbark 4cdb34bc0c ref-manual: Edits to sanity class.
(From yocto-docs rev: 36e90ca3cf797d6147f8cdd069d192e3f2669460)

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 cca4368b1d ref-manual: Re-ordered classes that start with "S".
(From yocto-docs rev: 1c3ec203dcab27f0119ce89573ba279777ccbbe3)

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