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 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>
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>
Added ASSUME_PROVIDED and SANITY_REQUIRED_UTILITIES variable
place-holders. There is no text there yet but they are there
for placeholders.
(From yocto-docs rev: adfa77dc597303dcff0e95fd4b3ffd5ae2fb08d5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the full set of first draft revision edits for the
new migration section for 1.7. Comments from Paul Eggleton.
(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable has been replaced by the KERNEL_MODULE_AUTOLOAD
variable. I updated the description to note that and to provide
a cross-reference to the new variable.
(From yocto-docs rev: 8b2f464f7d100db1c585ccc62d7cab89f7f7b164)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This description was a bit confusing with the way the general
syntax was described so I re-wrote it a bit. Also, added the
requirement that if you use module_conf for a given <modname>,
then you must also include the <modname> as part of the new
KERNEL_MODULE_PROBECONF variable.
(From yocto-docs rev: 15b7819a0d9946ad6565576a6f28897e2dd724f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a space-separated list and not a comma-separated list.
(From yocto-docs rev: 23cf09ac128289e878bbc056e28060008ab5217c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was confusion about how this actually worked when you
do not create a package for a package listed with the variable.
Cases for when the build would throw an error or not had to
be clarified.
(From yocto-docs rev: 02f95339322afe53db816b3b73234490d835b1ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6629]
Added a new variable description to the glossary and also updated
the IMAGE_LINGUAS entry to have a back-reference to the new
variable.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 219097735c57a3dc10195511dd5b199e73b8a094)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6621]
This is a new variable that helps control how debug symbols and
source files are split off when creating -dbg files for use with
GDB.
(From yocto-docs rev: 506b79707f6aec7c14f1f9d7e5099d20fca45c0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The initrd image used by the Linux kernel is list of file
system images concatenated together and presented as a single
initrd file at boot time.
So far the initrd is a single filesystem image. But in cases
like to support early microcode loading, the initrd image need
to have multiple filesystem images concatenated together.
This commit is extending the INITRD variable from a single
filesystem image to a list of filesystem images to satisfy
the need mentioned above.
(From yocto-docs rev: 051ef2e4d6480b28d21a59a79b6f0dca1a5944bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6499]
Fixed a couple example INCOMPATIBLE_LICENSE examples so that
they now use the canonical licensing names GPL-3.0 LGPL-3.0 AGPL-3.0.
(From yocto-docs rev: d2d6be323d1a5ed9da88b7924954f9733a78da84)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* INITSCRIPT_PARAMS - noted the default
* INITRD_IMAGE - added a reference into the image-live class.
(From yocto-docs rev: 152cb93ca591c46a1344f2f09e0f85f14519ddf3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6499]
Updated three areas to include similarly licenced components
regarding the use of non-GPLv3 licensing.
(From yocto-docs rev: 88c0720e4070be58fbde17bc04db2b53c3307bf8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a reference that was not linking to the manual but
was instead referencing the Source Directory structure.
(From yocto-docs rev: aae3fb868e95ef2dbd548a5f9d1ea61a013190cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Conflicts:
documentation/ref-manual/ref-variables.xml
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the ref-manual, I added a new variable description for the
PTEST_ENABLED variable.
In the dev-manual, I added a note to the "Adding ptest to Your
Build" section to mention that the OpenEmbedded system uses
PTEST_ENABLED to enable or disable building ptests and that
the user does not set this variable directly.
(From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a bit about values being passed through the
update-rc.d command and then a reference to the command's
page.
(From yocto-docs rev: e007414608ed801e440b701d6c43dca955a11611)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the link into the section for understanding how
OVERRIDES work.
(From yocto-docs rev: f897b9d0cc51899f3e4ce05b69a3c1dd429780d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
