These changes are basically Paul Eggleton's review comments.
(From yocto-docs rev: bb92dbb968013952c4308b9aeed48223f49c866d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The final paragraph of the "Creating Your Own Distribution" really
should have been in list form and should have some cross-refs
for other parts of the manual. The paragraph is now in list
form and there are some references.
(From yocto-docs rev: 02c4b2e99a3237d1506887659be0e67d6b000648)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a couple of notes to point out the ease of creating your
own distro and not just relying on a Poky distribution. One
note is at the very beginning of the manual and mentions
Angstrom as an example of a distro based on the YP. The
other note is at the beginning of the second chapter.
(From yocto-docs rev: 1525a5e34c615cbfd25aeb12cc7a27ef95b51eab)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the "var-" part of links for the creating your own
distribution section.
(From yocto-docs rev: d419cd67084ce25d0d4b4437d8ce4cec180da59a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3403
Provided a note at the front of the "Adding a Package" section
explaining the exception when using a closed curly brace character
inside a shell function with the character at the front of a
line with no leading spaces.
(From yocto-docs rev: a1c0972083751444a8cc89aa8a026f273d98e23e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #2645
Several changes to make sure that the default toolchain directory
(opt/poky) is understood as the default. I changed some wordings
to call it out as the default. Some examples I left alone as they
used /opt/poky but I clearly indicated that the example was using
the default installation directory.
I also updated the note in the manual that talks about alternatively
building the toolchain installer. Previously, it mentioned two
methods. I have added the third and most significant method that
uses bitbake image -c populate_sdk. This method creates a toolchain
installer that contains the matching sysroot.
(From yocto-docs rev: 2e5eeb7e0c9aa448149cc369572b31dbc1603e28)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #1622
In the introduction paragraph I added references to the three
multilib examples that are located in the meta-skeleton layer
within the Poky repository.
(From yocto-docs rev: f284525c6f9b655a61a0ac052a637b0aedb5b694)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3274
Applied several recommended changes for the section describing
best practices when using YP in a team enviornment. these
changes were from Dave Stewart.
(From yocto-docs rev: 7efc9864dc6757e3cf5c026f3c1785e5947cbfec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3274
Applied various review edits from Richard Purdie. Additionally,
I ran a spell-check on the chapter and caught some typos.
I fixed these as necessary.
(From yocto-docs rev: 794a13d26bb7a9e268b16f809158a6af58cc3ce8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3274
First draft of a re-written section that describes best
practices for scaling the YP over a large development
effort. this draft is based on Richard Purdie's text
he sent to me.
(From yocto-docs rev: e5135f76946997a0a060dd16c0b62308be4f6048)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3684
These changes help tie in the relationship between how the OE
build system uses checksums and such and the PR Service that
can track revision.
(From yocto-docs rev: 39a3010a3bb4b2c1d37aef60984ac16e85b56aac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3728
The poky-db-pdf.xsl file has code that controls the font color
for the headers, footers, and separating lines for each when
the PDF version of a manual is made. I changed the values
from #cccccc to #999999 to darken these up so they can be
seen a little better.
(From yocto-docs rev: c9c83028a5f13dc672414b6ca395290f05019f8e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3552
Added some links to the FILESEXTRAPATHS and SRC_URI variables.
These links connect appropriate sections to a newly improved
section on FILESEXTRAPATHS glossary description.
(From yocto-docs rev: a58e7c6f013393c87381411f918e16a8f04d55d1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #2684
Applied some review comments to the section from Richard
Purdie.
(From yocto-docs rev: 772617a45df10e5e42364854fe03d8aad7cb46b6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #2790
Created a new section in the "Debugging Build Failures"
section to deal with host issues that cause a build to
fail.
(From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These types of links must not span multiple lines in order for
mega-manual to process them.
(From yocto-docs rev: bcea042cd796a51d866f82399b2fd0cc89ec9e2b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
three PNG files go away from the eclipse folder due to the
renaming of the poky-ref-manual to ref-manual.
(From yocto-docs rev: 29907784ecb509b3d4fba633b2c4970e4105bea2)
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>
I placed a link on the term "Cross-Development Toolchain" in the
section of the same name. This is to help the user see the
recipes related to the toolchain. The link resolves back into
the "Terms" section of the dev-manual.
(From yocto-docs rev: c77ec0212bcf3b1c5f8079ccf08129ecbefea0aa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a bulleted list to the "Terms" section to help define
some toolchain recipes such as gcc-cross-initial,
gcc-cross-intermediate, and so forth.
Added a cross-reference link to the term
"Cross-Development Toolchain" in the the "Working Using
Stand-alone Cross-development Toolchains" section.
This gives the reader a way to see more on the toolchain
recipes.
(From yocto-docs rev: 2cb612424c0cf6addfd8bce8a0ef77665c35bd9a)
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>
Fixes YOCTO #3838
First draft of edits for this class. Removed specific variable
definitions as they are now deprecated. Added a general
explanation of the variable functions. Pointed user to the
commented code in the actual class for details. Removed
statement saying that the build system supports only one
binary per package.
(From yocto-docs rev: bd574f2c8a95470c5a44500b70743a6e039522b7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the question that asks "How doe the OpenEmbedded build
system obtain source code and will it work behind my firewall
or proxy server?". Some of the variables did not have links
or proper font type.
(From yocto-docs rev: be1f665b480a47483595381c9a837892100007e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
added links for the PREMIRRORS and MIRRORS variables used in
the description.
(From yocto-docs rev: 1ec0f9cbeebeaeaadee8cc8b3631e6194c013a2f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that describes an efficient way to set up the
build system to look in local areas for tarballs needed updated
so that PREMIRRORS was not the focus. The example used does
not even employ PREMIRRORS. So I changed wording to support
the example. I also added a mention of the PREMIRRORS variable
and a linked reference to it for more information.
(From yocto-docs rev: 7966942e2dfad85c2eb9480d7f706355871c40ab)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Received a patch from Robert P. J. Day but deleted it from
my Thunderbird account so could not apply it directly.
I applied most of his corrections. A couple I left alone.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 2cadd5265fcb5cc281c22ccae81260a6633229e2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3664
Added some information in the note to point out that not all
append files add files into the mix. Some just exist to add
build options. And, in this case the _prepend part of the
FILESEXTRAPATHS statement is not necessary.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 388c441341006227be2f9e7d42bb1c509c32790d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3272f0d51e3d09f4ffd96b7322f66ffd878d3714)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two things fixed:
1. A couple examples for setting up a layer.conf file were
using the meta-yocto configuration file as an example.
Turns out this is a bad example because the BBPATH variable
is appended to the LAYERDIR when setting BBPATH rather
than the other way around. That is because meta-yocto
is a distro layer. BSP layers, however, are not distro
layers and are the norm here. So I switched up the way
BBPATH was set and actually called out meta-yocto-bsp
config file as a template.
2. Added a link for the BBPATH variable in the
FILESYSTEM_PERMS_TABLES variable description in the
glossary. Just happened to notice this so I fixed it
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 1a594b6dde1a494a5f7322b510e1e67d23635298)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3662
I added more information to the variable desription in the
glossary for BBMASK. The information included a bit more
syntax information as well as some more complex examples.
I added more reference information to the "Excluding Recipes
From the Build" section to help better describe how the
BBMASK variable works.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f10f43a543e7b0892863e165d2902741a8823009)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed YOCTO #3662
Updates to the description so _prepend is used to add paths
to the front of the search order and use of the variable
without _prepend just adds paths to the end of the
FILESPATH order.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 44c98058c1a75a9e6c95e4f33dbe1696e23d97d0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3662
New entry added.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 73f8b28f6b6cea16cf63b99db88c961f87088fe1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The chunk.quietly option disables the output of the docbook
chunker. Creation of a new html file is now longer printed to the
console. This provides a much cleaner output of the eclipse makefile
target.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When calling the eclipse target twice without calling clean in between
the figures folder was copied as a subfolder of the existing figures
folder. This patch fixes the copy command to correctly copy the
figures folder.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The script tools/eclipse-help.sed is used to convert links that
point to other documentation parts. This avoids having to leave
the eclipse help center when clicking these links.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The file is used when creating eclipse help html files. It processes
all html files and converts links so that the user can navigate
between different docuementation parts without leaving the eclipse
help center.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eclipse help documents are now created when calling the 'make all'
target on the yocto-project-qs. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The fake title section is converted into a docbook
article.articleinfo. If used with a custom title page this will lead
to the excapt same output. But I will enable the creation of metadata
from this title information.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This target will generate eclipse help for the yocto-project-qs using
the yocto-project-qs-eclipse-customization.xsl stylesheet.
The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The quick start guide is currently not using a title information to
set the title of the document (e.g. article.title or
article.articleinfo.title).
As other output formats may use the title information to create
metadata this information has to be added to the document. To preserve
current style of the document a custom title page has to be used. With
this for instance 'article.title' can be used instead of the
fake-title section currently used, leaving the style intact.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eclipse help documents are now created when calling the 'make all'
target on the poky-ref-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the document used to create metadata for output formats
such as eclipse help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This target will generate eclipse help for the poky-ref-manual using
the poky-ref-manual-eclipse-customization.xsl stylesheet.
The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eclipse help documents are now created when calling the 'make all'
target on the kernel-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the document used to create metadata for output formats
such as eclipse help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This target will generate eclipse help for the kernel-manual using
the kernel-manual-eclipse-customization.xsl stylesheet.
The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eclipse help documents are now created when calling the 'make all'
target on the bsp-guide. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the document used to create metadata for output formats
such as eclipse help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This target will generate eclipse help for the bsp-guide using
the bsp-guide-eclipse-customization.xsl stylesheet.
The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eclipse help documents are now created when calling the 'make all'
target on the dev-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the document used to create metadata for output formats
such as eclipse help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This target will generate eclipse help for the dev-manual using
the dev-manual-eclipse-customization.xsl stylesheet.
The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eclipse help documents are now created when calling the 'make all'
target on the adt-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the document used to create metadata for output formats
such as eclipse help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This target will generate eclipse help for the adt-manual using
the adt-manual-eclipse-customization.xsl stylesheet.
The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Additional parameters are required so resolve links between different
documentation parts inside eclipse.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Furthermore supporting new output formats can now be achieved by
creating a new customization file containing its corresponding
parameters. Parameters that are used across different stylesheets with
different values will then be separated through different
customization files.
Global parameters can still be set through the XSLTOPTS variable since
this precedes the parameters in the customization file.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of a pdf document is part of the image used on the title
page. Thus the title defined (e.g. bookinfo.title) in a document
should never be used when creating title pages for pdf documents. As
other output formats may use the title information to create metadata
the title has been removed from the template.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated a couple spots in the manual to be clear on meta
not being a strict requirement for a layer name.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ffd80ade292a462a77981c8c19bb71a19333a397)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3661
The value for FILESPATH was incorrect. I have replaced it with
the value found in base.bbclass.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: bc100cdd1bec48a65fcc4bed281f42953b1c9077)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3663
I added wordings to indicate that meta-intel is not required
to create a BSP layer. But, the example presented uses
meta-intel.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 746948cd1d612f0b837e70a7e92e4081d379cb50)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Part of section 5.15.1 incorrectly implies that only copyleft
source will be archived to the specified directory, when in fact
copyleft filtering is disabled by default.
(From yocto-docs rev: 8eacef8acc398bc3d881d657d27c8827f05e3227)
Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example doesn't account for an extra level of directories
that organise the sources by machine type.
(From yocto-docs rev: 844e8b8f28ab765e59fdbee40e00c973b1b00d89)
Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #3684
Updated the section that declares what the default BB
Signature Handler is.
(From yocto-docs rev: e4c64add4a54e5583bf88fc71f00c90f7a1f6440)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No longer including the Yocto Project Kernel Architecture
and Use Manual. I removed the lines that included this
manual as part of the mega-manual.
(From yocto-docs rev: 69fa3cc4a07fc471fc869a81ff2545d62b63286e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I took out the logic that built the old YP Kernel Architecture
and Use Manual. This manual can no longer be build. It is
being retired.
(From yocto-docs rev: 8d5b179995e561deb94572150e904da5cd4dec19)
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>
Added bits to support building the new kernel concepts
appendix.
(From yocto-docs rev: 6d372bd12288142b09c729f877c1e894f11c7c27)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The concepts in three bulleted items in the old kernel manual
need to be present in this new manual. I put in a bit of text
right at the beginning of the manual in the form of an AR for
Darren. This will eventually be removed, but for now it is there
so that it won't slip through the cracks.
(From yocto-docs rev: 85b7300df30837f72d936f8ec1af0b2a4a9c1a88)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in a cross-link to the new YP Linux Kernel Development
Manual up in the introduction.
(From yocto-docs rev: ba00acb1a0db9494b0d0ff1335f2532b5e2a7994)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I went through and got rid of all references to the old
YP Kernel Architecture and Use Manual and replaced with
appropriate references to the new YP Linux Kernel
Development Manual.
I also laced in appropriate references into various sections
of the new YP Profiling and Tracing Manual.
Also, updated the list of resource manuals to reflect the
new manual set (addition of kernel-dev and profile-dev and
removal of kernel-manual).
(From yocto-docs rev: ef531ad65c9b749dad5e8e39b060bf1641e4fa38)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added some cross-references to the section that overviews
the user-space tools. Three tools (perf, oprofile, and
systemtap) are in the list. I added appropriate cross
references to the respective tool sections in the YP
Profiling and Tracing Manual.
(From yocto-docs rev: 9b1ee95fa9dd4110f5b4f9e7aeaba63c6ef8b148)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Many links added to the glossary variables that were introduced
in the manual.
Also provided general edits as I found them.
(From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also put in a cross-reference in the existing KERNEL_SRC
variable.
(From yocto-docs rev: 705074a16490155cd64469af3b2ea12a0780281c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Terms" section, I enhanced the "Metadata" term to include
a bit about Metadata in the context of the kernel. This type of
metadata is discussed at length in the YP Linux Kernel Development
Manual.
(From yocto-docs rev: c6f48bc4c33850eaa1dbf5867759a19d373766ce)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. LINUX_VERSION_EXTENSION: Added a link on the
LINUX_KERNEL_TYPE variable.
2. Added a new variable description for the
LINUX_KERNEL_TYPE variable.
(From yocto-docs rev: f4ace3c64838044e2eb700af4b024a96ab1e2315)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied Darren Hart's review comments. Namely, use the
example from the linux-yocto recipes and not the custom
recipe.
(From yocto-docs rev: 4a537a02bbf6fca4ff1a3beddd03d8115099cddd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a bit about the variable being used to define PV for the
recipe.
Also, fixed a couple indentation problems with some nearby
variables.
(From yocto-docs rev: bec65049218c9c549fe8cd4d5c16e9d917e87866)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Took them out of the colored Note format and replaced with
a simple line box to set them apart.
(From yocto-docs rev: 5efb84d3860d87f64371b718967ab33f47a3a4db)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed "Line" to "Live" in the section heading.
(From yocto-docs rev: 73ea1f5a01891aa51c872363a60d2e0eefdf2f64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the list of 32 profile-manual figures to the tarfile
variable for mega-manual.
(From yocto-docs rev: ffe0586990c7659c28001038d6ba55cd42f5ecd0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figures from the profile-manual/figures folder must be
added to the mega-manual/figures folder in order for the
mega-manual to make correctly.
(From yocto-docs rev: f64459330b472dbade936f9d964b4792fb6364bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No re-writing at all.
(From yocto-docs rev: c18bd94ac0e6fc3a23139ec8d1ef7b04518746de)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No re-writing at all.
(From yocto-docs rev: 6ed32ad5daa1f16c414da665a2fea498baefbe4a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No re-writing.
(From yocto-docs rev: e3fd833c4bf7cdc50138ac940af8a2b35c37c52b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No re-writing at all.
(From yocto-docs rev: f42230e3665903a7603212696949241244555f8b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No re-writing at all.
(From yocto-docs rev: 4ca472f8200f9d927a8d37c88c1ff75b017fcfc1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No re-writing, no clean up what-so-ever. It is simply in the
DocBook form.
(From yocto-docs rev: 3d2c17c076b67c3e2ab094d0562038e422b63d44)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had the sectioning off and it was preventing the manual from
making. I also added more indentation as needed throughout
most of the manual up to the error.
(From yocto-docs rev: 5de3544593a63e96b349babc177970d8605e0098)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This adds in the figures under the correct spelling for the
"figures" folder.
(From yocto-docs rev: 83d7896623a9a88538dd1da45429f47777123338)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Initially the 'figures' folder was mis-named as 'Figures'.
this is not in line with the other manuals. I had to rename
the folder and thus delete all these files from the Git repo
since they had been committed.
(From yocto-docs rev: 4452e790e8ddb8c80a5f0c6faf4a1f86fd3fb8d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to change this file to work for the profile-manual.
(From yocto-docs rev: 60a52fb31f2d15709afa29e83aa5d50bf8d90c58)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Finished entering the rest of the "perf" section.
(From yocto-docs rev: 3df34a299ef9656362bf5b851b575528c646c02b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Started to put in the usage chapter. Adding text and
sectioning off by paragraph and formatting for literal
sections.
(From yocto-docs rev: c2d328d19023cd6fac6dcaeb8449e2203b5a17b7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I put the raw text is for chapter 4. No editing.
(From yocto-docs rev: e4a017624595394f86f469e15c1c8ad13e82206d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the raw text from Tom for the architecture chapter.
No editing at all.
(From yocto-docs rev: f402cc14ac7fef30460e130cc5bdfca731886aa3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this text is straight from Tom's wiki. no formatting
no nuthin'
(From yocto-docs rev: 95f5341169c3e8d3bd7a97740320d0d27cbee020)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added four chapters to the directory. I based these chapters off
of an existing YP manual. I also updated the .gitignore file
so that it will support ingnoring profile-manual make operations.
(From yocto-docs rev: f9658f627fe9d8d6868ce74e9550ea16d23c4156)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added links for the LINUX_VERSION, LINUX_VERSION_EXTENSION,
and SRCPV glossary entry terms.
(From yocto-docs rev: be6c716f436a631e97f8a429aa9b2d2fa75816e5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed all the orginal text.
(From yocto-docs rev: 8a3b11fb6936574edb4fd0daf60d21ee2c2ccd8f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the block of original text.
(From yocto-docs rev: ff36ef73cbf50b966bf539b013260fb7c668d82e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the original text.
(From yocto-docs rev: 0f3e89c7e6b8249cd643822f33c8168ca7cd83c9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Final tweaks to this list of variables.
(From yocto-docs rev: d494c8b06a623ef4930e206dd8e5689c8a9d4923)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the name of this section to be consistent with "doing"
something as the rest of the chapter is action-based. Did
some other minor edits. Also, removed the original Darren text.
(From yocto-docs rev: 3be86ee72766207c3812245917b8b20af86b26f4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits added a couple cross-refenences back into the YP
dev-manual where detailed examples of patching and configuring
the kernel exist.
(From yocto-docs rev: 1ae2a18f0367841d1ea9bb8d3f3d323a9b573533)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
fixed up the organization of how you modify a recipe. It can
consist of three things. I have created a new subsection for the
first item, creating the append file.
(From yocto-docs rev: a8342ccf18c0406669f6983da31d38603d87921e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Second pass through this section. Also removed the original text.
Switching to numbered list.
(From yocto-docs rev: 7978c5acd4776e6ade7c0ee34c6f7ab58eeb2bb9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the name of this section and took out the bit about
the manual being written with the assumption of a custom
layer being created. The manual does not particularly call
this out with any examples so it is not needed.
I pulled the copy of the original text also.
(From yocto-docs rev: c7623d96ed2d9c5866e52842f8cfea2ebde95d0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A serious pass through this system to reorganize it.
(From yocto-docs rev: f13abc59730d78e5ffa5bce3d38519f8fc4c127f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The sections for "Machine Branches" and "Feature Branches" really
should be encapsulated within a section on branching. Much of
the text in the "Machine Branches" section presents the rationale
behind both types of branches. I have created a larger section
to contain these and will edit the text to fit.
(From yocto-docs rev: c7c67f5867f22ebbbd49cab79bb2d4e52422ecac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Three instances of *.scc files were recursively including themselves.
These .scc files needed to have their names changed to a file
that indicated hardware support only.
(From yocto-docs rev: f1c347f8f63141807084ac0a2bd3b64e138315cb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First re-write of this section. Terminology is an issue here.
Dumping the term "ktype" for good.
(From yocto-docs rev: e5ee05c5bfec2a0c62b89245efbe248a66b66288)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First real re-write of this section.
(From yocto-docs rev: 636a852d4748904df6794bef391f7f5ef3db3c0f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
first real re-write of this section.
(From yocto-docs rev: 09a9d0978d939f40782179f9fd46ccd7b999c262)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First real re-write of this original text.
(From yocto-docs rev: a6d16b61057df8ed811cf1f5f27c5f9e08be1108)
Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First real re-write of this section.
(From yocto-docs rev: 41c79da0832c0b290b21cc2aff87091d7243fafa)
Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the first serious re-write of the text from the
original. Edits to make it more readable.
(From yocto-docs rev: 21c77fdfc9ae1a02b1d02fb113324c96c6aecb5e)
Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First real pass at cleaning up the text.
(From yocto-docs rev: a550e96780b5be191a576bbb20ef28a36b20e0bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General edits to clarify the writing.
(From yocto-docs rev: 0510ab0faf81e0ac1c931863337eb217581c66ed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some re-writing for better understanding based on what I
know.
(From yocto-docs rev: fc3adb037ac07a90dfbba6b76643391480e0bce5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General edits for readability, etc.
(From yocto-docs rev: eb52c743ad0fba7859ee4800f12981294aa71b23)
Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also put in the initial text for the next section, which
is "BSP Descriptions."
(From yocto-docs rev: 0c9b0475d9c1a97c7b00df325dad0c830e30444b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Changed "poky-ref-manual" to "ref-manual"
2. Inserted new lines to support "kernel-dev" manual.
(From yocto-docs rev: a134992633572c0b006ae73d47512be89d13ba8e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The version changed from 1.3 to 1.4. The poky-ref-manual changed
to ref-manual. And I added the new kernel-dev manual. For now
I am leaving the kernel-manual book. Likely it will be replaced
later.
(From yocto-docs rev: 3df7476724c96e97f309118fb6d906a999414093)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The raw text for the second chapter is in by section. This has
no formatting whatsoever. I also edited the Makefile so that
the new "Common Tasks" chapter would make as part of the manual.
(From yocto-docs rev: 68bcc1e977fbdd7b1a4b448171d1149edc72db51)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added in the variable YOCTO_DOCS_KERNEL_DEV_URL as a placeholder
for the variable used to resolve to the published manual. This
will need changed when we decide how to retire the existing
kernel-manual.
(From yocto-docs rev: 0a42af6c02b3fc6ebcad5be47d69c66ff0ced7ac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes were to the intro chapter to introduce the DocBook
form, the Makefile to introduce the new manual, the figure used
for the title had to be updated, the root manual .XML file needed
changed, and the style sheet.
The manual now makes with just the raw text for Darren's intro
section.
(From yocto-docs rev: 1bceb7bdd4fe5773c11c7ddbdae00554680bbf6d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert P. J. Day suggested adding http://lists.yoctoproject.org/
listinfo to the list of mailing lists, which included yocto,
poky, and yocto-announce.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f322c60814471e4216e112b193e5769fd6008a79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Added "Debian" as a distribution for best results.
2. Fixed a link to the Hob page and two links for the
Build Appliance.
3. Three typos fixed and a few grammar items fixed.
(From yocto-docs rev: 0b381094ed9cc2d66895d4ad7c63005c8a918eb1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this still had the "poky-ref-manual" string in it. It needed the
"ref-manual" string.
(From yocto-docs rev: f771aaa09bf439e506dc5d8573a34283a1a905fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Substituted "1.4" for "1.3". Substituted "dev-manual" for
"poky-ref-manual".
(From yocto-docs rev: b0b92c85f402c2280312ed909f4c4b976da28c54)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to change 1.3 to 1.4. Also had to change poky-ref-manual
to ref-manual.
(From yocto-docs rev: e0448415218bacc7ce6555cad47e60a2dc7fc287)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
One of the examples used "startline" instead of "beginline".
Correction made.
(From yocto-docs rev: 1ed3ae72b0492e03b37dc2c9519cf37209a7034b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the old poky-ref-manuals from the new ref-manual
structure.
(From yocto-docs rev: b5db4ddea205875ed3acacb90f46efd557337e0d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the variable to use "ref-manual" instead of
"poky-ref-manual" to support the new folder name for the
YP Reference Manual.
(From yocto-docs rev: 9dc6ff494c6841cb4830b6932a2b5faf4645ba98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updates to allow the reference manual to be built as
ref-manual.htm and ref-manual.pdf.
(From yocto-docs rev: 2bac348d4f4c5e7385fc4a250d1f40f070edb15b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changing the folder that holds the YP Reference Manual to be
"ref-manual". This will help with confustion over the manual's
intended purpose.
(From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The file structure beneath WORKDIR has changed such that
PN and PV are now separate directories. This affected several
areas in poky-ref-manual.
(From yocto-docs rev: 52b033c2c9e5aaa1f03072dd16c21a9d59a87150)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The STAMPS directory is now structured as
build/tmp/stamps/$MULTIMACH_TARGET_SYS/<extended_PN>/$PV.
There were three areas in the manual that needed adjusting
to reflect this change.
(From yocto-docs rev: 1f8d64ecfa8e060680a90f9c6cc5f69554328da5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated a note that points the reader to the maintainers list. The
note in the master branch pointed the reader to a nonexistent (old) file.
(From yocto-docs rev: d947d6d9bd42562a84ad3ac90e4c2052f421119c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3176]
Several places throughout the YP manual set examples are given
for the bblayer.conf file. For release 1.3, a bug existed that
surfaced when a user removed either the meta or meta-yocto
layer from this configuration file. The bug has been fixed and
the ripple effect through the YP documentation set affected
several manuals.
Fixes include updating the code samples that show bblayer.conf
so that they now include the BBLAYERS_NON_REMOVABLE variable,
a new glossary entry for the variable, and an explanation of
both BBLAYER and BBLAYER_NON_REMOVABLE in the section that
talks about the bblayer.conf file.
(From yocto-docs rev: 904b9ec1cd6d823af0e92f6891fc7e434cf2e358)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clean operation should also remove the *.tgz file. I added
code so that if the user makes the file and specifies the
'clean' target, the generated tarfile is removed.
(From yocto-docs rev: 565c147eaa169e287278b87e9bba2979a44be9d5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
White space at the end of a line in the DocBook .XML files
presents a problem for certain Git commands. It evidently
shows the white space as red-highlighted errors. I have removed
the white space from this concepts chapter.
Also, fixed one grammar item.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: dd0ab98a655ae61008d18cef44940622a901c9f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 0fc811748fce26f9c14791a286742905b51e77a6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3327]
Applied some edits to make it more accurate based on
Paul Eggleton's review comments.
(From yocto-docs rev: 94c15c9550fba77a2ab079502a62916357de0cf5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3327]
Re-write of the glossary description for the
PACKAGECONFIG variable. This went through a couple of
iterations. Paul Eggleton reviewed and provided
technical information.
(From yocto-docs rev: 7edf3d03bc4a448516f24caea4b49423a026885f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2843]
The poky.ent file has variables to list the essential host
development system packages required to build a headless
system. The OpenSUSE distro requires python-xml. I also
inserted some carriage returns and line continuation characters
in the strings for all the distros so that they are formatted
better in the resulting manuals.
(From yocto-docs rev: addbd0da1a35addcdd8a3d1bdf3812db68d96b2f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3445]
Updated the "Installing the Plug-in Using the Latest Source Code"
section for the Eclipse section. This was pretty much out of
whack. I have created new steps that involve running the setup
script and then running the build script. The new information
still needs a review.
(From yocto-docs rev: 5903964a9583c6051abefa4a7b944b59a76825b4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3274]
I have added a new area at the bottom of the current
"Using the Yocto Project in a Team Environment" section.
This section is the spot for addressing what Richard Purdie
coined as "How to use YP in a work group." For now, the
changes are based on the information that Richard placed in
the Bugzilla entry. Presumably we can build on this information.
(From yocto-docs rev: 92c5d1b6ac6b553fab19410170364dca40123c59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the example to match the more elegant solution
provided in Robert P. J. Day's wiki.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 209d6205b4fc6a4010f440ba7e0e2018217a0a0b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2909]
Applied a few changes based on Paul Eggleton's review
of the section.
(From yocto-docs rev: 54c2b1577ba062e09a8df14767257147e33a939f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3292]
Added a bit to the start of the Features chapter to give the user
a method they can use to discover recipes that are checking for
features added to the image.
(From yocto-docs rev: 261cc16ad900f7f5254fa97dab82beab94f717d3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two links to the wiki were pointing to diff pages and not the
actual pages.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 7339ea7b0a3869570c9097146a49dfd758527197)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2909]
Updated the "Using a Development Shell" in the dev-manual to note
that the OE_TERMINAL variable is the thing that controls what
terminal is spawned. Added a reference into the new
variable description.
In the poky-ref-manual, I created a new glossary description for
the OE_TERMINAL variable.
(From yocto-docs rev: 25001eba312c4109b4aaa79b334d27e144ef0d3f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2909]
Updated the section on using a development shell
(From yocto-docs rev: 37b43dcb19dda747b7e90ac2e393dad29e9d87a5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3292]
Provided a specific example for how adding a feature through
the MACHINE_FEATURES variable can affect the build.
(From yocto-docs rev: a768c88c73ef15a1e40e2547b6bb12ef276472b5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3292]
I added more detail about the list of machine and distro features
to the introductory paragraphs of these sections. This information
came from Paul Eggleton.
(From yocto-docs rev: a032f8e49222f6b628eb7d337b967da51a3d7581)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3292]
Partial fix for this bug.
(From yocto-docs rev: 300d23b29d8abf236cbfa6f2630322c58ca67854)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some review comments from Paul Eggleton on the new
build history section. Some minor re-phrasing.
(From yocto-docs rev: 986b0e7d2a79141d7c8dea0062cd25970a74fa57)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-ran this using Danny and the configure.in command does
not need a AC_CONFIG_HEADERS statement so I removed it.
Also fixed a typo for the touch command s/ChangeLog/ChangLog
(From yocto-docs rev: 51aab0d5af1067f4144dacd3e53964aa6e00c2b0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example configure command did not have the correct shell
syntax. I changed it to "./configure".
(From yocto-docs rev: a14ab06b78248cbf7caead26ee27a9d23e75d2ef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2645]
In the section that describes how to build a toolchain using
bitbake meta-toolchain, I updated the note about the MACHINE
and SDKMACHINE variables. These needed to be pointed out
to the user as important variables for correct settings
before generating the toolchain.
I added a new section for the autotools-based programs that
now includes a simple "Hello World" example. This section
precedes the section that describes how to pass host options
to configure.sh.
(From yocto-docs rev: 9849e7b94d42a851f30f0fba8ae60916697956dd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3364]
Added information about the default behavior for the
BB_DISKNOM_INTERVAL variable.
(From yocto-docs rev: db1c6c4e9cd749109580aa6b135f6f84f3fe652d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3366]
Created a new section titled "Handling Optional Module Packaging"
in the dev-manual. This section is based on the wiki page
that Paul Eggleton authored.
Created a new glossary entry for PACKAGES_DYNAMIC in the
poky-ref-manual.
(From yocto-docs rev: 5af3da5e2af15c33e5e6eb7a9ef3ab3c0923284f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3396]
Spaces in file and directory names is an issue for the build
system and throws an error when sourcing the environment
setup script. I added key notes in several areas of the doc
set. I also added some cross-references to the oe-init-build-env
section in some other areas where running the script is discussed.
(From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added variable descriptions for BB_DISKMON_DIRS and
BB_DISKMON_WARNINTERVAL. These went in the reference
manual in the glossary section. First draft for both
descriptions.
Also, updated the Makefile to include two new figures used
in the Build History section. The figures needed to be added
to the TARFILE variable so that the .PNG files are included
when publishing both the poky-ref-manual and the mega-manual.
Added two figures to the figures directories of the poky-ref-manual
and the mega-manual. These figures are part of the new Build
History section. Anytime you add a figure to any manual you
also have to store it in the figures directory of the mega-manual.
(From yocto-docs rev: bbf68ed28ba8660af34d4cae146fb172ca4e681e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First draft of this new section. Information based on Paul
Eggleton's wiki.
(From yocto-docs rev: b459d68ab7dd51b258fd378ad15260cba4522dc4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I improved the wording such that it is not confusing between the
information in reference manual's section on running a build and
the general overview presented in the YP Quick Start.
(From yocto-docs rev: 17e2fc34941612589b8ddf3314a4760e9c2f402d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note alerting the user to required host development packages
necessary for ADT installation and use was antiquated and did
not point to the new structure, which is in the YP Reference
Manual. I updated the information.
(From yocto-docs rev: edced821838391315fb2f12488cffec9f08eb78c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made changes to the poky.ent file to change the three variables
needed to build manuals for 1.4.
Made new entries in the manual revision history tables for the
five manuals that have them. Each entry shows the "TBD" release
coming up.
(From yocto-docs rev: f7f75a238d709698f1582ce22e209c09ee60581b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed used of "Source Directory" and Build Directory.
(From yocto-docs rev: a4d79c5a7e73003fc99c274d876fbea453a80d20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
various changes as required.
(From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made minor changes as needed due to some new sections, links,
and capitalization standards.
(From yocto-docs rev: bc966e5a78dadd14ecf1896a36e40a9b256bae77)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated some example text based on the latest source
repositories for crown bay. Replaced fishriver example with
fri2. Updated some capitalization usage for source directory
and build directory.
(From yocto-docs rev: 65973f7b30699fbb82b4d7f1b907e947489ba7d0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some minor edits to the book before locking down the
files for 1.3.
(From yocto-docs rev: 2b941103585a31b5dbcb65b784cc3381467ed697)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a few references and links. Also standardized on the
capitalization for the term "Source Directory" where it
refers to the YP poky structure on the development machine.
(From yocto-docs rev: 1a20418d8791d754ad66c5a059e65bd68a4c6b32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the sections on the "Git Workflow" in Chapter 4 and
the "Patching the Kernel" section in Chapter 5 per Tom
Zanussi's review comments. Minor technical changes.
(From yocto-docs rev: fd8a291349c06328adebd37f8a9bbeaa49adb44c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the DISTRO_EXTRAS_RDEPENDS variable to the glossary and
updated the DISTRO_EXTRAS_RRECOMMENDS variable per Paul
Eggleton's review.
(From yocto-docs rev: bb27fcb3b990bb335176d5da9fec420fdc31bf22)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this figure used to be at the end of the development manual.
I have removed it from both figures directories and taken
it out of the TARFILE list in the Makefile.
(From yocto-docs rev: ad8fcfc4bddb6bcee0e1a4ece78cd87ab0d51b6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Suggested changes to help clear up what the list of items
in each of these variables should be and how automatic
handling of libraries is dealt with.
Richard Purdie reviewed the changes.
(From yocto-docs rev: 53865f904d5d4675286419a57bbb9282edfc1d0b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some final edits to these two variable descriptions from
Paul Eggleton.
(From yocto-docs rev: b606eed0f6a326ef572cd831b642312bb827a8c5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Final edits (I think) to this section from Paul Eggleton.
(From yocto-docs rev: 95fd830ffb668109631205df4538454ccf023b20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the MACHINE_FEATURES_BACKFILL,
MACHINE_FEATURES_BACKFILL_CONSIDERED,
DISTRO_FEATURES_BACKFILL, and
DISTRO_FEATURES_BACKFILL_CONSIDERED variables to have
more comprehensive information.
(From yocto-docs rev: 355eb3ebe02fbe4a340adaf83bf29a46f7c8230f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did some re-wording on the WiFi example in both the
MACHINE_EXTRA_RDEPENDS and MACHINE_EXTRA_RRECOMMENDS
variables. Clunkiness fixed.
(From yocto-docs rev: 0c76ae0ee14cce62ff02b728b1c9ac21f4f3b385)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The sections that list the features you can provide with the
MACHINE_FEATURES and DISTR_FEATURES variables implied that
the set was finite. It is not. I added wording to that
effect.
(From yocto-docs rev: d8e79fdf909ba5586dc45320b7cca03de639f49b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed wording so that the lists of features do not seem
to be finite. But rather, the set shipped with YP.
(From yocto-docs rev: 68e1eba075819863d8137be0b4c70935b88cb1a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Did some editing that helps clarify variables that deal with
the MACHINE.
(From yocto-docs rev: f1f63acffc952cc7d755fc6dd555379572fddaf0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For consistency.
(From yocto-docs rev: 7b51db2d3409d6a9c74a7a9b0b2cc39cf6622033)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the BB_NUMBER_THREAD and PARALLEL_MAKE variables into
the description for suggested variables to set if you edit
local.conf.
(From yocto-docs rev: 7345bbf6c10b823e6364e85a4e75a7ec60a29aef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3262]
* Added correct information to the STAMP variable glossary
entry.
* Created a new variable glossary item for the
MULTIMACH_TARGET_SYS variable.
* Created a new variable glossary item for the
EXTENDPE variable.
Reported-by: Patrick Turley <patrickturley@gamestop.com>
(From yocto-docs rev: ea50e41dc71d3876dd1b00aeec663400ac4a5ced)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updates to the Git Workflow section based on feedback from
Darren Hart. These changes simplify the flow and make it
generic.
* Updates to the lttng user space tool used from within
Eclipse. The legacy version of the tool is no longer supported
so it had to be edited out of the description and replaced
with the 2.0 version.
(From yocto-docs rev: 81d2b79035fc99f92364bfef2c76076738cbaa52)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
One change resulted in changing out "include" for "require"
in code from the Crown Bay example.
(From yocto-docs rev: 69b21d5f62ad9020646a26ce13d349af50aee419)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several variables are no longer needed in this section. I have
removed them.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: b627269d18d9c8b4342f8465966d780756ff5a22)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Feedback from Paul Eggleton suggested to not use the linked
term "Source Directory" in the last paragraph of this section.
Reasoning being that it is mis-leading in this case. People
reading this will be thinking more along the lines of traditional
source code rather than our establishe "Source Directory" term,
which in the doc set refers to either the unpacked poky tarball
or the cloned poky Git repository.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: f9bfcdebf85481839df01442ee81c4c9e8ee559a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note explaining why "PATH" is needed when using
SSTATE_MIRRORS if the shared state directory structure on
the mirror is the same as SSTATE_DIR.
(From yocto-docs rev: 94b8a45827d2bf7f16ec530de694ec5e4e6ed164)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the release month in all the manual revision history
tables to say "October 2012" from "Sometime in 2012".
(From yocto-docs rev: 1fc9313fe6c69db3d8cece6d940f78a2f0dc8386)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new chapter dedicated to migration information for
the user updgrading from a previous YP release. Also had to
include the new chapter in the poky-ref-manual.xml manual so
that it will build.
(From yocto-docs rev: df8e02c17bc8157ad4abd1e4954f762ccde8915c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This entry was situated so that it was not in alphabetical
order. I moved it.
(From yocto-docs rev: f545414ead63ff58557142acdf416bd5e58d5c45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Edits to get the patching the kernel section more sane.
* A tweak to the opening sentence of the compliance section to
rid it of the split-infinitives.
(From yocto-docs rev: 8e2ff293e85a602efd98aceb20da5a2ea5f2a34d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made changes to try and clean up the process.
(From yocto-docs rev: 9c4fbcb473dc594647ba8779162379a745f8f8d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created the new section in the reference manual that lists the
distributions that support YP.
Updated the section in the QS to reference the new section in
the reference manual.
(From yocto-docs rev: ff85945574466b2e6431fbaa0026cdea9d96ac9b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add meta-yocto, meta-yocto-bsp and meta-hob
* Remove meta-rt - this was merged into OE-Core (meta)
* Remove meta-demoapps - this was dropped
(From yocto-docs rev: c90a8f85f4462caa49c7da2e7ec4541534bee57a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some wording changes from "packages" to "recipe" as appropriate
in some of the variable glossary entries.
(From yocto-docs rev: 8f3d72dad9b68f78987a497092d74ff3f7e35b28)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We haven't supported ipkg for some time now - it was replaced by opkg
(whilst still using the ipk package format).
(From yocto-docs rev: 07b3dd9a73be25f31c919ed750ca320c7507eff0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Use correct/up-to-date names of package systems
* SUMMARY does not default to the value of DESCRIPTION, it's the other
way around (although the logic may be improved in future so that this
is the effect).
(From yocto-docs rev: 4ec095f0f45cb3a62a8dfdd1a098b23cbe1dc7b5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Document DISTRO_FEATURES_BACKFILL and MACHINE_FEATURES_BACKFILL. We may
wish to expand upon this in future, but at least this explains what
these variables are for and how to use them.
Also add a link from the DISTRO_FEATURES entry to the section that lists
valid DISTRO_FEATURES items.
(From yocto-docs rev: 018af5c28b44464ae66646780ade910bdcab2bef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Extend the description of the DISTRO variable so that it mentions that
this points to a .conf file under conf/distro and mentions what happens
if the value is left blank.
(From yocto-docs rev: 50f8f0394d8d849e0a227d6c9ffcdc3cccb7e307)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a description of the PACKAGECONFIG variable to the variable
glossary.
(From yocto-docs rev: 07d08314d3151de7073567a7800156f69fdb549e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Extend the description of the MACHINE variable so that it mentions that
this points to a .conf file under conf/machine.
(From yocto-docs rev: dd82b176bb059d03faec1abdd406e4cf8f0e5afb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adjust the descriptions so that it is clearer that these are specific
to a machine and should appear in the machine's .conf file, and are
intended to affect the image contents, not the dependencies of a
specific package. Also change the examples so that they demonstrate more
realistic usage scenarios for these variables.
(From yocto-docs rev: 3c3b8b117b09d78637ae8c4d27f77194cf197ea9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3118]
LICENSE_PATH is the correct variable to use for 1.3 - see:
https://bugzilla.yoctoproject.org/show_bug.cgi?id=3118
(From yocto-docs rev: 96b93175d662696c3c2f25c0d8aa73ab6c5abdd3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some general edits to the new "Patching the Kernel" section.
Also had to remove a couple of images no longer used in the section
from the Makefile "TARFILES" variable.
(From yocto-docs rev: ac61e22e2f89926fbbda56fbaa4384c3c5156360)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the temporary text in the new "Patching the Kernel" section
that was copied from the old appendix A. Fixed the PRINC variable
in the creating a new layer example.
(From yocto-docs rev: 3eba77a81d3460866638a2f2d6b7c27d9dd1a2be)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the "kernel-example-repos-generic.png" file as it describes
the bare clone method for kernel modification. We are removing
that from this manual.
(From yocto-docs rev: c25c4f662c2f8a83fd9b09583646be9dbe01424c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the simpler version of the kernel workflow diagram to the
figures folder.
(From yocto-docs rev: c856fe320a0e70701f14312439fec6ccb707f9bd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel workflow section was re-written to reflect that the
kernel appendix has been removed. Also, changes to the flow in
general no longer make reference to the bare clone and the copy
of the bare clone as a method used to modify the kernel.
Many links were modified in other manuals as well.
(From yocto-docs rev: 38adbcb00d4305029cfa94e5ef047da41823f021)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure that shows the bare clone and the copy of the bare
clone are no longer needed. The description for the kernel
workflow has been reduced to discussing only modification of
the temporary source files. We are no longer talking about
creating a bare clone and copying it as a way to modify the
kernel in this manual. That topic will be described elsewhere.
(From yocto-docs rev: f6a25e5e3763ea7a1f8a81ce377e3b520143b852)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3245]
New glossary terms for SPECIAL_PKGSUFFIX, and MLPREFIX.
Also improved the definition of the BPN variable.
(From yocto-docs rev: d9eb38122967a5729f3a6aff1dae00427a22f579)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Common Tasks" chapter is better suited as the last chapter in
this manual. So I moved the development workflows up a chapter.
(From yocto-docs rev: 19f0a6411c065388b5bd0083338b164b43baff0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel example appendix is now gone.
(From yocto-docs rev: d744e76034ff2711a8c40b9bb1982971d28a04b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel example appendix is being removed. This broke a lot
of links. For now I have moved the information into a new section
called "Patching the Kernel". I have preserved the information
by adding the old appendix file as kerne-appendix-orig.xml.
(From yocto-docs rev: 994235a69362dfb0114ef9001ea7f2f2e2fdc5c3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Eliminated the section A.2, which had an example of how to use
menuconfig in the kerenl example appendix. The information is
now merged into the similar section in Chapter 4 "Common
Tasks." It was decided that the Appendix A examples in the
manual were too detailed for a general development guide.
(From yocto-docs rev: f88ec421b257657f02cc0f132ec2580c17f07cef)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
this statement in the linux-yocto-3.4.bbappend file needs to
have the comment removed so the source can be found.
(From yocto-docs rev: 821162221818f5ce53bb903aeef57c85314f5083)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the Kernel example appendix I changed some remaining 3.2
kernel strings to 3.4. Also I added the OE_INIT_FILE variable
from poky.ent for use instead of the "oe-init-build-env" string.
(From yocto-docs rev: 1d9d8d72d197bdd81756eed7fe1529f341de6089)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Richard Purdie
Timo Mueller
Kevin Strasser
scott-lenovo
Robert P. J. Day
Robert Cochran
Andrea Galbusera
Paul Eggleton