Fixes [YOCTO #5772]
Updated each manual's CSS style sheet to contain a style for
how the permalink symbol looks on its own and how it looks
when a user hovers over it with the mouse.
(From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3729]
I made an editing pass through this section. Found some minor
corrections.
(From yocto-docs rev: 314ec3a066de7328b6c6893ce33cc0e5faa8700a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I scrubbed the manual set for appropriate places to reference into the
do_clean* type tasks. Found and added several occurrences.
(From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6430]
The style sheets were carrying over old .PNG files that are not
part of the manuals. I have removed the statements that were
using them.
(From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistency on how we refer to a task name throughout
the YP manual set. The proper way is "do_<taskname>". Some
occurrences did not include the "do_" prefix. These have been
fixed.
(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Restoration of some parameters to make sure the TOC
is generated correctly.
(From yocto-docs rev: 0f4c4b526fd0e8c3cce3fc033c660112e5dc517f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Not having a section was messing up the TOC for the
FAQ in the mega-manual. I added a section.
(From yocto-docs rev: d4a34cb1815e3e12e73e08b5ae7b2027b5f03823)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3729]
I have made an attempt at understanding this and creating
a section that describes the steps the user needs to take in
order to build out-of-tree modules on the target device when
running an SDK image. I created a new section called
"Building Out-of-Tree Modules on the Target". Basically,
the user needs to be on the target and change to a directory
and then create some scripts before attempting to build these
types of modules on the target.
(From yocto-docs rev: e0754ae6dbc5dc07fb6707fe4b71ecd95c8180dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was an occurrence of the do_compile task mentioned in the
manual. I have added a cross-reference link from it to the new
section in the ref-manual.
(From yocto-docs rev: 0981ca8ca9856063d4daeaae155aabdfd1c7dcc8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Set the release date to April 2014.
(From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2444]
Replaced a couple instances where routerstationpro was found. This
reference BSP is no longer there and has been replaced by
edgerouter.
(From yocto-docs rev: 7ba629cc677310f04a17636e140142695242c5d2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made sure that the first occurrence of each "BitBake" term linked
into the "BitBake" term as defined in the dev-manual.
(From yocto-docs rev: 83e6e43d13cf5447b8ef65836d532abbb1f8b15e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a new step about how to use diffconfig task to create
kernel config fragments.
Scott fixed some grammar in one of the sentences after applying the
patch.
(From yocto-docs rev: 5b7ccdbf708cbeebc2d8dc91db129fb35aabdcdd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5857]
I had missed replacing the release date in the manual revision
history tables for the 1.5.1 release. It was still an estimate.
I have replaced with the actual date of "January 2014"
(From yocto-docs rev: fb9abe0df33a9b551d797ac1b72577931f5f8ce6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use of the way directory names were
handled throughout the YP documentation. I have scrubbed the
set and replaced many instances such as the following:
meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)
I basically got rid of leading slash characters.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Changes partially address this issue, which is the removal of
tarball installations for poky. The notes at the beginning of
the YP manuals suggested that the tarball version of a manual
might lag the version found on the website. Because we are
discouraging installing poky/documentation from a tarball now,
I have re-written the note to be generic and suggest simply that
for the most recent version of the manual associated with the
release, see the manual on the website.
(From yocto-docs rev: a5e96e7eb719e69bbcf2139af2e20230aedc4247)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
FILESEXTRAPATHS_prepend example is missing essential trailing
colon.
(From yocto-docs rev: 6287fee9fba7173cdd22fc9bbd4378367c75627f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated all six tables for both 1.5.1 and 1.6 releases. Both
entries need to ultimately be in the 1.6 version of the
manuals.
(From yocto-docs rev: ac1d2cc5686da142562cd674f7fa8908895a27df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Placed the release month of October in for the 1.5 release.
(From yocto-docs rev: c0431b2b3115d9687dcb5d3ba37adf6bf4695867)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5065]
I added a blurb at the end of the section that talks about in-tree
metadata. The blurb addresses situations where the user has changed
the metadata but not updated the corresponding SRCREV variables
in the kernel receipe.
(From yocto-docs rev: 5d3dc0e6ebc40b937c3f3ef397e2c94e7cb3b69b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The stock Note indicating that the user should consult the website
for the latest version of the released manual had a link to the old
kernel-manual. I have replaced it with a link to kernel-dev.
(From yocto-docs rev: 804e672e42a66aecdbe83ce239433216af10ef8c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is now a glossary description for the THISDIR variable
in ref-manual. I added some cross-reference links to the
variable in key places of these two manuals.
(From yocto-docs rev: 0d0f756c142c506a66ebc6a1a33e9f124dafd333)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Pointed out by Robert P. J. Day that I was using the wrong
FILESEXTRAPATHS example for an append file. I failed to include
the "_prepend" part of the variable. Also, the wording based
on the example made some assumptions and was not entirely
accurate. The changes I put in made the section very specific.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 659c5a9c41a92f469ea0ea3630e11b4ba2df8f56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert P. J. Day pointed out some implied meanings in this section
that indicate configurations from .config are exclusive somehow
from configurations applied through config fragments. That is
not the case. I have inserted a note to clear up that implied
meaning.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 5ac27e8a2aea662a8e70dda0e852b5ea401b8b00)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Changed the variables in poky.ent to contain the "1.5"
string and the "tbd" string for the unknowns.
2. Updated the manual revision history tables so to replace
the 1.4.1 release entry, which should not be there, to the
1.5 entry.
(From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff.
2. Updated the manual revision tables to have a new entry
for 1.4.1 release.
(From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section had some problems. It failed to mention the
need to extend FILESPATH by using FILESEXTRAPATHS.
(From yocto-docs rev: e627cf21242a62fb23e93fdae61e8cfce32082a9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Further down in the section, a second occurrence of ${FILES}
needed changed.
(From yocto-docs rev: 0212a1ebfef4c5a6a0ae76410f7753bbc41d3e82)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was inaccurately referencing the ${FILES} directory when
it should be talking about a "files" directory created in the
user's layer where the kernel .bbappend file resides.
(From yocto-docs rev: 2af3a71db6e6d99b9aa4b710e21f3f3bacff0b82)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Noticed the exact same paragraph at the beginning of Chapter 3
that also appears in the introductory text for the manual.
(From yocto-docs rev: 431cb58ca144bbf5aa49caa7dc2b728c3c92fe66)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-worded the title for "Set Up Your Layer for the Build."
This resulted in a lone link from the kernel-dev manual changing.
(From yocto-docs rev: bf797a9ad4b40ded6bd3b4dc8cc3d8ac702f05a6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit adds the three *.customization.xsl files. I
(Scott Rifenbark). Split the commit because after applying the
18 patches, the list of stuff to stage was huge and I did not
want to add them one-by-one. So I staged them using git add -u.
Here is the general cover letter information from Timo included
with the 18 patches:
-----------------
Hi,
the generation of eclipse help files has been merged from the timo
branch to the master. Since the creation of the timo branch there have
been some changes to the master branch (e.g. new documentation,
renamed documentation).
This patch set does some cleanup for the renamed documentation and
adds eclipse help generation support to the new documentation.
01: Removes the 'the' from the document titles
02..04: Cleanup obsolete artifacts resulting from the merge
05..08: Add eclipse help generation for ref-manual
09..13: Add eclipse help generation for kernel-dev
14..18: Add eclipse help generation for profile-manual
Best regards,
Timo
(From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Hi,
the generation of eclipse help files has been merged from the timo
branch to the master. Since the creation of the timo branch there have
been some changes to the master branch (e.g. new documentation,
renamed documentation).
This patch set does some cleanup for the renamed documentation and
adds eclipse help generation support to the new documentation.
01: Removes the 'the' from the document titles
02..04: Cleanup obsolete artifacts resulting from the merge
05..08: Add eclipse help generation for ref-manual
09..13: Add eclipse help generation for kernel-dev
14..18: Add eclipse help generation for profile-manual
Best regards,
Timo
This patch set originally contained 18 patches. I (Scott Rifenbark)
had to push these changes as two parts. This is the first part.
It does not include creation of the three cusomization files.
(From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The user needs to have YP 1.2.2 release or forward for the
examples in the book to work. I have added a note indicating
such.
(From yocto-docs rev: 6fcbd3f526a13ef632c7ce5b9b4774d166b61895)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "-dirty" String section from the old YP Kernel Architecture
and Use Manual was moved to section 2.3 of the manual. It needs
to find the right area to be put in (AR for Darren). I added the
AR text to the top of the section so it would not fall through
the cracks.
(From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A Section about seeing what has changed in a kernel tree
was moved from the old YP Kernel Architecture and Use Manual
to this new manual. The section moved was "Change Inspection:
Changes/Commits". In addition to moving the sections, I
shortened them up by removing verbose parts of the section.
(From yocto-docs rev: 2c620ea2bed0844b70b497dfa461c0b364312e39)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New appendix required adding the kernel-dev-maint-appx.xml
file. The contents are sections 3.2 and 3.3 from the old
YP Kernel Architecture and Use Manual, which is "Tree
Construction" and "Build Strategy." According to Darren Hart,
this information should be retained for the few people on
the planet that might ever need it. In addition to adding
the new file, I had to add the bits to the kernel-dev.xml
manual to support including the appendix when making the
manual.
(From yocto-docs rev: b25e40308080c59c6700e1dce8ebf6a9a2dafbcc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the "Kernel Architecture" section from the YP Kernel
Architecture and Use Manual to this manual. The section
included the kernel-architecture-overview.png figure. So,
I added that PNG file to the "figures" folder. Finally, I
had to also add the PNG file to the Makefile tarfile list
for kernel-dev. Note that because the figure was part of
the old YP Kernel Architecture and Use Manual, I did not have
to add the figure to the mega-manual tarfile list.
(From yocto-docs rev: fbc5508ce162ea7915fd5dce74338b6a5bfd7ce1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
João Henrique Ferreira de Freitas
Robert P. J. Day
Timo Mueller