Fixes [YOCTO #7386]
Apparently the "‐" ENTITY used throughout the YP manual set to
get literal "-" characters in example commands renders into a unicode
that is not a dash. This results in users getting errors if they
attempt to cut-and-paste a sample command that uses a "-" character
from the manual into a shell. I have universally replaced all the
"‐" strings in the YP manual set to "-" strings.
(From yocto-docs rev: ef6dbf591eee70866f163e3c98454b6145f4fa3a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I typically try to use the underscore character to string together
multi-word user-input descriptors in examples. I fixed a bunche
here.
(From yocto-docs rev: 68474b5a8b5c96b0fc19fda29e667369f4606e31)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the introduction, the ref-manual references several other YP
manuals. If the manual is build separately, these references resolve
to the appropriate manuals. When the mega-manual is built, the
same references are designed to not become links. In otherwords,
mega-manual.sed processes those links out. This is by design.
I found a #profile-manual tag on one of the links in the introduction.
This resulted in a link in the mega-manual that would go nowhere. I
removed the tag.
(From yocto-docs rev: fdaf114ece20994ec55061612ab53e9334afde26)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In an attempt to keep the project as much open source as possible,
I removed the link to Intel from this list of resources. We don't
list Linux, OpenedHand, Wind River, etc.
(From yocto-docs rev: 5efe375a94a14d4a70aa2c3ff9ab39d6c7362526)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
An old note still existed in this entry that stated we don't support
glibc. This is not true. I deleted the note.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: e72f248f45678fb445e60106dd338c4d9cd114d8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7630]
Apparently the text relocation being done here can cause runtime
performance issues. I documented a potential work-around for the
issue and provided a cross-reference link to an external site for
more general information about text relocation at runtime.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: f7ba2fd03ee40c5dbe6a07a24a63d9147857ed78)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Style sheet was not spacing after the first paragraph for glossary
entries.
(From yocto-docs rev: fb08aec5303ed21315839c55b413873569497f23)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involves the following:
* Inserting a new row for all manual revision history tables
to have "October 2015" and 1.9 as the release information.
* Updating the mega-manual.sed file to process links for 1.9
* Updating variables in poky.ent to deal with the 1.9 release
variables.
(From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7559]
Added some explanation on the syntax. As it was, the positionally
dependent nature of the script's parameters was not accounted
for. This is now explained. Also, talked a bit about the
bitbake-cookerdaemon.log file.
(From yocto-docs rev: fcf52a15acea2d75df9c84550d7e73c988ffb4bb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A cut-and-paste error had left a "package_deb" string in the
first sentence of the section. Replaced with "package_rpm."
Reported-by: Geoffroy VanCutsem <geoffroy.vancutsem@intel.com>
(From yocto-docs rev: 38b20d775ba41cb14d86177dddd85ada32fb3f86)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7559]
Removed the information stating that the port address 12345 is used.
Really what happens is a random port address is used.
(From yocto-docs rev: f469c2431b26593a762e348e9c5d0e84c582eab8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated this according to some changes Richard and Paul wanted to
see make it into the 1.8 release.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: f571e35169818355fea2a20715df3e8f7405134f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added xlstproc to Fedora and CentOS package lists for building out
the docs.
I abbreviated the list of references in the end chapter by leaving
just the main URLs for bigger areas such as Intel, OE, etc. Then
I put in a link that goes back to the dev-manual list of other
informations as that is much more comprehensive.
(From yocto-docs rev: 81667b85cd8c639dd32cd5a8f614b4c890eb4dde)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed an out-dated note near the bottom regarding a distro
we don't support
(From yocto-docs rev: 4211914f16d4ab01182633785068b56a258c0d04)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We did not have time to do this for 1.8. So, I restored the look
of the glossary pre-images. I did leave commented code in both
the glossary chapter and the style sheet for later.
(From yocto-docs rev: 9f1472b7d4cd86545e7927b0f693aafc88ae2791)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some suggestions from Paul Eggleton to downplay the role
of this variable. It is basically ignored now in all parts of the
manual set except for the descriptions of the variable itself
and the BBLAYERS variable. I added some text reinforcing the fact
that BBLAYERS_NON_REMOVABLE is ignored by the build system and only
matters if you are using Hob.
(From yocto-docs rev: 98112751aaec6e25de48d9e3ee56592be3f53a07)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The docs are not building on CentOS and we think it is due to the
XSL templates being called for the Eclipse parts. I located all
the "current" templates and switched them out for "1.76.1" version
as are used by the mainstream doc builds.
(From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example was ancient so I consulted Bruce Ashfield for a better
example and implemented it.
(From yocto-docs rev: e737f380ca5bb36c0095f11182cd3e3a93791e61)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7386]
Apparently, copying HTML displayed commands that have a
double dash created through "‐‐" in the docbook source
causes some issues in the shell. I have scrubbed the manual set
to replace any "‐‐" strings with "--".
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: e88b813b71d7d6d8acd8a8638f2db71265145b64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tweak a number of doc lines so that the KERNEL_FEATURES variable
refers directory to .scc files, and does not take advantage of
potentially confusing shortcuts.
(From yocto-docs rev: 6236fb098fc2d518f6f4f63e16b19a06a775d2d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fill out missing machines for the MACHINE variable.
(From yocto-docs rev: 2b8179cfb7e3a25d95c43f9160d284ebd5deefc7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some edits to the areas where KBRANCH is discussed.
Clarified that setting it is not optional any longer.
(From yocto-docs rev: 4d0b2d92140d066048d9ff36453c7ea589eebe55)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This variable is out. There were some references to deal with.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: fcdd5de04c722ebde2d3f236310c46a251cf1afc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed traces of the deprecated KBRANCH_DEFAULT variable.
(From yocto-docs rev: 8130f0db46be872cd857d8579323e4ad00da6380)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7358]
Added a new variable description.
(From yocto-docs rev: 42ff075319b346f22d2c604c0de249ac3039a992)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two areas affected by this change. I updated the KBRANCH and
PREFERRED_VERSION variables in the glossary. One change in the
KBRANCH area was getting rid of the deprecated Crown Bay example.
I substituted in the Emenlow BSP.
(From yocto-docs rev: d7ed727ab5828dc257361c558a86a298bc537748)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the PNG file for the context to be the first item displayed
for a given glossary term. The PNG file must be negatively indented
though to look decent.
Fixes [YOCTO #5601]
These reformatting changes were needed because of brower incompatibilities
discovered with the existing solution for displaying these PNG files
with glossary terms.
(From yocto-docs rev: 06aeb6540c1343825369dd02006cb19e5a318d48)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the PNG file for the context to be the first item displayed
for a given glossary term. The PNG file must be negatively indented
though to look decent.
Fixes [YOCTO #5601]
These reformatting changes were needed because of brower incompatibilities
discovered with the existing solution for displaying these PNG files
with glossary terms.
(From yocto-docs rev: c84c4bc91b10e1443dc5aefc3a987a370d25432b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7306]
Some review updates to have better wording.
(From yocto-docs rev: 6f2d10c87128934958295111d10e038689fd94d3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Scott Rifenbark
Robert P. J. Day