Added a new glossary entry fro CONFFILES and I updated the existing
description for FILES. These two variables are inter-twined. FILES
was a one-liner and definitely needed expansion.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 6788128c459ccf04f932c2273aca1e6b88f0def0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No longer applicable according to Paul Egglegton.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 503884d2e3b49bd8102fc64f5487361dae0160aa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The information surrounding the central download directory was
pretty scant. Jim Abernathy pointed this out in an email sent to
me. As a start, I have added quite a bit more information to
the glossary description for DL_DIR. Part of that added information
is a pointer to the FAQ entry that describes exactly how the
build system gets source files. Then, in the YP Development Manual
in the section that introduces the build process, I added several
references to various variables that are set in the local.conf
file prior to kicking off the build.
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: 4d7835a3bff5bd054301fa9ab6954c11c88dad58)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the glossary entry for the IMAGE_INSTALL variable.
It was not complete. I also updated the section that describes
how to modify the image through the local.conf file. These
edits are out on review with Richard and could undergo some
further tweaks.
Fixes [YOCTO #1897]
(From yocto-docs rev: 41124cdd9e69b9f17300a609cce2ae4c9ce57b54)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a glossary entry for BBMASK.
Fixes [YOCTO #1935]
Reported by: Gary Thomas <gary@mlbassoc.com>
(From yocto-docs rev: 4406a8b0b85ac15070e2ccb1c57ef9801827a7f7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the PDF version of the reference guide there were several glossary
variables that did not format correctly. The issue is that the two-
column list had instances where the variable name overruns the
variable description. I added an extra line return for these cases.
(From yocto-docs rev: bef1a8dfdc0529b270102d0336a7bd6d1500b68c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made another pass over the variables that affect the root filesystem
size generation. The changes are based on review feedback from both
Saul and Joshua.
(From yocto-docs rev: ccd569d7e464a219a1a3ff9b063e431ba3c946de)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added three new glossary entries for how the build process
figures out the image size. Entries are for IMAGE_ROOTFS_SIZE,
IMAGE_OVERHEAD_FACTOR, and IMAGE_ROOTFS_EXTRA_SPACE.
I still need to create a usage section for this topic.
Likely this will be in the development manual in a new chapter
I am thinking about.
Fixes [YOCTO #1110] partially.
(From yocto-docs rev: ec6b9d77d10a95f0a2d460dca3cf8eab5dfbf0c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A new glossary description for LICENSE_DIR. This variable extends
the COMMON_LICENSE_DIR that YP uses to find license text during
the build.
Reported-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com>
(From yocto-docs rev: b96736e88e1432e9c8b3b2eb5385e1193d66f3f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New glossary entry added.
Reported-by: Darren Hart.
(From yocto-docs rev: 03845586f7331630bd1d9b5eebb9df9eccbd05a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Text that suggests setting the BB_NUMBER_THREADS and
PARALLEL_MAKE variables to speed build time has been updated to
suggest a setting of twice the number of host cores supported.
The 2x number came to light through a discussion on the project
mailing list initiated by Robert P. J. Day.
Reported-by: Robert P. J. Day
(From yocto-docs rev: 1846b41a595b7bd905ca828eaa04112d1533d7a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added this variable description in the glossary.
(From yocto-docs rev: 12a9e5b4dfc399ff2037355aa1062f907a62e76d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the second pass for re-documenting RDEPENDS, RRECOMMENDS,
MACHINE_ESSENTIALS_EXTRA_RDEPENDS, MACHINE_ESSENTIALS_EXTRA_RRECOMMENDS,
MACHINE_EXTRA_RDEPENDS, and MACHINE_EXTRA_RRECOMMENDS. These
variables are in dire need of better explanations and examples.
(From yocto-docs rev: cc60bd4c50c7b19209dae06307aec26e962cf476)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did complete rewrites of RDEPENDS, RRECOMMENDS,
MACHINE_ESSENTIAL_EXTRA_RDEPENDS, MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS,
MACHINE_EXTRA_RDEPENDS, and MACHINE_EXTRA_RRECOMMENDS. These are
sent out for review but these changes represent the first attempt
to clear up confusion on how the six variables are used and relate
to each other.
(From yocto-docs rev: 1d93707fb9383d51322e96eb521e96fcac8bcc47)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided better descriptions of these variables and some examples on
how to use them.
(From yocto-docs rev: 3a5cce8c9ba02f90b3554a6f800f69c2e8e77911)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a more robust description and provided a couple of usage
examples.
(From yocto-docs rev: b8b842b57cc003f1351a551041fe4b3de2fcbfd6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added sterner wording on usage and provided an example.
(From yocto-docs rev: 32e07fafadb602b93c9f7b8a78e5baf4c7e1ab5e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the description of POKYLIBC to note the variable is not supported
and provided a link to TCLIBC. I added the entry for TCLIBC, which
was missing.
(From yocto-docs rev: d76a1ddb79577a3e121df3d590fb601b5e5fbb98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Noted that POKYMODE is no longer supported and provided link to TCMODE.
Added richer description to TCMODE.
(From yocto-docs rev: a7a326c2c8f4c5f29f3a9723a6895a7113a78357)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor re-wordings to give some context on how to use these special
files and the variable to point to them.
(From yocto-docs rev: 4482b42f4a224bada7a0fa5fe4821a753ba55d80)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Per Paul Eggleton's suggestion I updated the description of this
variable. Some minor wording changes as well as covering two
automatic handling features.
(From yocto-docs rev: 15be3502ca20f657051e02d698b459328328fb14)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several manuals and areas were still referring to 'glibc' as the
GNU version of the Unix statndrd C library. We do not support this
any longer and now use 'eglibc' to build with. Notable changes were
in the required packages area of the QS manual. I also added a
bit in the reference guide saying how this release does not use
'glibc' to build with but rather 'eglibc'.
(From yocto-docs rev: c2c58914996d747c510706d78ecfd8f41c5e694d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable for images that use the ipkg packaging system. These
are packages you don't want to install even when the recipe calls
for it.
(From yocto-docs rev: 78d53b5da4bbd6889a34be8a1c795a5658cb6b1e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I noted that the developer should remove this option from
EXTRA_IMAGE_FEATURES before they create a production image.
(From yocto-docs rev: 8de6c789d1a1ed5e721c16f53bb27de18ae88238)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This bug was filed by Gary Thomas and was requesting more information
on the "hows" and "whys" of setting up your own package repositories.
At this point, I have added information to help the user understand
build performance issues when choosing between the RPM and IPKG packaging
systems. Likely, there is more that needs to be added to fully address
this bug.
For now, I added explanations in the packaging class and glossary areas
of the YP reference manual, a new paragraph in the YP QS just prior to
firing off a build, and a new bit of information in the configuring
PMS in the ADT Manual.
(From yocto-docs rev: d0025f862cb85ca741787b4737dca286e3ebfb45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them. However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2. After merging them to my yocto-docs/master
branch I fixed some issues.
(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add note about specifying a full revision ID to prevent querying the
remote server on every parse
* Mercurial also supports this variable
(From yocto-docs rev: 47ce273dd751b0ae32b5c53310b6aedc4dade2ef)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add documentation of LAYERVERSION, LAYERDEPENDS and new layer priority
behaviour
* Improve some wording
(From yocto-docs rev: be7c10f3b8b35ff231e5974a48936e66fd49fcbc)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* xterm is now the default
* Konsole from KDE 4.x will no longer work due to changes in behaviour
(From yocto-docs rev: 031a619ca19dbc2011a4df7bba1c332f2770e15d)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document that LIC_FILES_CHKSUM is mandatory, when gets validated, and
improve some wording.
(From yocto-docs rev: ca878d7b0c84812ef29bbaf5894c96dd89500ec9)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable was renamed (to match OE) in the Yocto 1.1 development
cycle.
(From yocto-docs rev: 5cda8fe3b5dd18b629ccd13427da3b5743ae66ce)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The links to the lettered divisions of the glossary do not work.
I changed them to the first entry for each lettered area.
(From yocto-docs rev: b7692bcfa19fb940a050c0cf72dc2f7e427b8ba7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the document, several variables state their default values. I set the
formatting to surround a default value with double quotes in all cases.
I also fixed a typo for "RECOMMEDNS"
(From yocto-docs rev: 3da85f54df6fd4ad64d5be2cc9ae0e6dd50a68f5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I also fixed formatting and some minor wordings.
(From yocto-docs rev: b1bbfe89cb250ef5267fb16635dc41338aab0c59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a cross-reference to the EXTRA_IMAGE_VARIABLES glossary
term and provided more explanation describing the relationship
between the variable and the IMAGE_FEATURES variable.
(From yocto-docs rev: 227c11b8d81e9ae266b7e60172d0a5e9e1237ed0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
YOCTO #1104 - Added a glossary entry for the EXTRA_IMAGE_FEATURES
variable.
(From yocto-docs rev: f81a85322d944d33484da73020593891811a045a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
BUGID#_807 - I updated the description of the BBFILE_PRIORITY variable
to provide more detail. Input from Tom Zanussi on this fix.
(From yocto-docs rev: 90f9fd0c3bcf5c772423fa53f1f00579eba1bdeb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to some changes in the file structure for 1.0 there is a new directory
for the shared state. The variable SSTATE_DIR can be used to point to
the directory. I added this variable to the list of documented variables.
(From OE-Core rev: fe939d7181856145ea26c193be131883da182fcd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cyril submitted a patch via email form for several spelling corrections. The master docs, however, are not up-to-date with what I have on my contrib area. Many of Cyril's corrections were already addressed. A few were not and I have updated them here with this commit.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Added an entry in the glossary for INC_PR. Also updated section
"Package Revision Incrementing" to mention the use of INC_PR in conjuntion
with the PR and PV variables.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Scott Rifenbark
Paul Eggleton
Saul Wold