Fixes [YOCTO #7306]
Added an example for when the user tries to inherit the most recent
version of software through use of the SRCREV variable. When using
SRCREV = "${AUTOREV}" PV does not always get ${SRCPV}, which it need
in order to fetch the latest software. I added a clarifying example
to explain this situation.
This commit also has a small change to fix a broken link to
EXTERNAL_TOOLCHAIN. We do not documentat that variable so I removed
the link.
(From yocto-docs rev: 82f66a7193d0e40ffd65547223d4d9b10fdcf9bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4907]
I created a new section in the toolchain chapter of the adt-manual
called "optionally Using an External Toolchain". This provides
some fundamental information for the user that wants to use
an external toolchain. Additionally, it references Mentor
Graphics Sourcery toolchain as an example.
In the ref-manual, I updated the TCMODE variable description to
better integrate the MGC Sourcery toolchain as the overriding
example.
(From yocto-docs rev: 51e9c3b88f7e5a16da2aa101589b0f2612fff11d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The image feature 'debug-tweaks' has been fragmented into three
separate areas of functionality that deals with handling empty
passwords and post-installation logging. I updated the list of
image features appropriately and the description of 'debug-tweaks'
in the EXTRA_IMAGE_FEATURES variable.
Fixes [YOCTO #5344]
(From yocto-docs rev: ce0ab20472a75049298287cd05109f6e091b80bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates to the following:
BUILD_ARCH
SOURCE_MIRROR_FETCH
TARGET_PREFIX
SDK_PREFIX
SDK_SYS (I added this one new).
(From yocto-docs rev: ad5f9b56dc912783b415b30604456bd5071f9721)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5601]
Discovered that the solution I had to display a small PNG file
to indicate the context a variable is used in the build system
was not displaying properly in the ref-manual variable glossary
when using the Chrome browser. The solution was to adjust some
settings in the CSS file and place the image after the term.
This allowed me to dump the webkit stuff that I had inserted
into the CSS file styles to make it work in Mozilla, which
ended up not working in Chrome.
Additionally, I needed to update the 'define-generic.png' file to
have less white space on top as part of the figure. Note that
this commit adds the figure to Git for tracking as well.
(From yocto-docs rev: 59a1295aeb1c866f330634907ad28642a997cd63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied a different example from Paul.
(From yocto-docs rev: b21ef6a792361eb0893ee17524794fba3bed885c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Small typo fix for STAGING_DIR_HOST. Some re-wordings for
TARGET_PREFIX.
(From yocto-docs rev: 919a13436de6ea150f685a50b6ecc8154b75da86)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did a significant re-write on this description as I had the
meaning pretty far off.
(From yocto-docs rev: 6bcc63ac83f0aeb3d3d06db33c7a8f010c737312)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-worded the way you say the date.
(From yocto-docs rev: 3c6b51fb474628954654f2f1290509a78a48a1fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed the meaning up.
(From yocto-docs rev: 1b057475acd2bf33bb6fa3bd03e85a415697873f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added an example.
(From yocto-docs rev: 7a22c2941618f29ad89087c186ae2af6f0c07323)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some review edits to these two variable descriptions.
(From yocto-docs rev: fb1eb903b9bcc8b0bb67e72c795a1dd602143589)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mark Hatle reviewed the section and I updated some things based
off his input. A rewrite to the "Makefile-Based Projects" section
to get it technically correct. Also, removed all SDKROOT
documentation from both the adt-manual and ref-manual.
Fixes [YOCTO #7133]
(From yocto-docs rev: dd785777834611d94868a3774f2eb21ffc081b1a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the ADKROOT, GDB, CROSS_COMPILE, and CONFIGURE_FLAGS
variables to the glossary. Also added appropriate cross-reference
links from the adt-manual to those new variables.
(From yocto-docs rev: 812367e3b915b99d900b7934c4d5d409f393e814)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the description for the SOURCE_MIRROR_FETCH variable
so that it actually made sense. The [doc] string was also
updated.
Found a typo elsewhere that was fixed when I spell-checked the
file.
(From yocto-docs rev: 609f09231815f80ea3fd800e0b5d9a4fbad110cc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on "Handling a Package Name Alias" was confusing and
wrong. We decided to eliminate it. The section was removed from
the dev-manual. The corresponding variable DISTRO_PN_ALIAS
remains for now but without the cross-reference link to the
now missing section.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 9938cdcc8488baffa4252288bf45243055e76fed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed out the occurrences of eglibc and replaced them with
glibc.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7133]
This goes toward fixing the bug but not completing it. I have
added the following variables to the variable glossary:
SDKTARGETSYSROOT
PKG_CONFIG_PATH
CC
CXX
CPP
AS
LD
TARGET_PREFIX
AR
STRIP
OBJCOPY
OBJDUMP
RANLIB
NM
(From yocto-docs rev: c9d9e422684dad7cdc81db309235d0d1751ac88a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This option to the PACKAGE_CLASSES variable is broken and not
supported. I added several warnings saying such. We opted to
keep the documentation rather than eliminating it completely to
prevent questions should someone find the code and wonder why
it is not documented.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 1acf3da2034c4c3f74acee1ccb375f0450ed90a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way the old manual set had worded the use of the
BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS
had become depricated. It suggested a lot of user intervention
to get these variables set to have the build system utilize
optimal parallelism. The change a while back to the build system
where the variables are set to the number of build host cores
now makes the variables automatically be set to their best
values. I have gone through the manual set and changed wordings
appropriately to reflect this.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3a27b1792c92a2f22173315e2732f672cdad2c78)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor edits to the original patch. These edits were caught by
Robert P. J. Day.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b50a2e44eccd50166351611f17c643cbbc60f8b8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Placed a reference for more information on the variable into the
section of the dev-manual that explains how to choose a device
manager.
(From yocto-docs rev: 3f9b1329fe4794af03d673323d11558e85d9b097)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had it out of order alphabetically.
(From yocto-docs rev: d766cc58dfe2581599815b76729c742034c910ef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the following variables based on slight review changes
from Paul Eggleton:
EXTRA_AUTORECONF - changed autoconf class to autotools
KERNEL_IMAGE_MAXSIZE - Wording tweak
AUTO_LIBNAME_PKGS - Wording tweak
DEBIANNAME - [doc] string updated
TCLIBCAPPEND - Second clarifying sentence in first para added
PACKAGEGROUP_DISABLE_COMPLEMENTARY - [doc] string updated
(From yocto-docs rev: ff5c765ffab1cdf6fc8a007cebdf7114432f65ef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added descriptions for the following variables:
EXTRA_AUTORECONF
KERNEL_IMAGE_MAXSIZE
UPDATERCPN
AUTO_LIBNAME_PKGS
DEBIANNAME
DEBIAN_NOAUTONAME
TCLIBCAPPEND
PACKAGEGROUP_DISABLE_COMPLEMENTARY
CLEANBROKEN
DISTRO_CODENAME
BASE_WORKDIR
DISTRO_FEATURES_DEFAULT
DISTRO_FEATURES_LIBC
Part of adding new variables is checking to see if a previously
undocumented variable is used elsewhere in the manual. One
occurrence was spotted and turned into a link for this list.
(From yocto-docs rev: bb75387b7aa4fcb0b594d300772952d81a651644)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update entry for IMAGE_BOOT_FILES with information on glob
patterns.
(From yocto-docs rev: ad3fc0061e3f4dc3ecc6b0a101685c301c5690e9)
Signed-off-by: Maciej Borzecki <maciej.borzecki@open-rnd.pl>
Signed-off-by: Maciek Borzecki <maciek.borzecki@gmail.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5463]
Updated the notes in the TUNE_ASARGS, TUNE_CCARGS, and
TUNE_LDARGS to indicate that the BSPs select the tune and then
selected tun affects the tun variables themselves.
Also combined the TUNE_PKGARCH and the TUNE_PKGARCH_tune variable.
We really don't need the TUNE_PKGARCH_tune variable as it is simply
the TUNE_PKGARCH variable with the override.
(From yocto-docs rev: dabc624272a9bb4cf5e62dee664ba729a9887208)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6158]
Updated the style scheet file to format glossary variables in
such a way to allow for a PNG file of standard size to be
displayed below each variable. Right now, the PNG file is a
generic placeholder. Each variable displays a PNG file.
Updated each variable to include that PNG file.
(From yocto-docs rev: 24b7b847b7093022a49a014395df0c3a8c019331)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5600]
Added a <info></info> tag pair with a short description of the
variable to each variable in the glossary. The short description
is what will be used in the documentation.conf file. Scripting
from engineering will pick up the variable description
automatically. The information between the tags does not
appear in the HTML or PDF output.
(From yocto-docs rev: 57fb9100e377a96c330be20613c5895b25910022)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the third set of review comments from Paul Eggleton to
some variables.
(From yocto-docs rev: 2be5bc26a6fda1922ee73a874522180633d33b98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For consistency, I changed the introductory sentence to the
variables that function when inherited.
(From yocto-docs rev: 6ba4fe635c45abf7692f4be0a09ede89a89ec9fa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits were minor with the addition of some descriptions that
had to be fleshed out. All comments from Paul Eggleton.
(From yocto-docs rev: 4ae7c5a5e5aa23307e28de0832d379145c4ef8f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Pascal Bach
Maciej Borzecki