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>
