| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* small number of typos fixed.
* documentation corrected in a couple places.
* for most part, reduce line lengths to 80 for printing.
I was going to fix just a couple typos, then figured that while i was
there, might as well do some cleanup, mostly in the area of reducing
line lengths to 80 where possible for printing. feel free to comment
on any other possible aesthetic fixes, i can add them and resubmit.
(From yocto-docs rev: cfe4c061d8691e128933b81693aa42c809ef5486)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
| |
This reverts commit 914c482bd89071ab34b3381e3bd8065f871cc047.
I had to revert this change because it broke the footnote behavior.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
I discovered some artifacts and inconsistencies with how the YP
Quick Start was made. I made the following changes:
1. Changed the structure of the QS from "article" to "book"
as it is a separate book. This change doesn't fix anything
but it does bring the XML file closer to passing validation.
2. Removed the <abstract></abstract> tag. This tag was in place
simply to display the PNG file for the Yocto logo in the upper
right part of the first page. After turning the QS into a
book from an article, the title could be displayed as a PNG
file similar to the other books. This change solved two issues:
1) removed the empty "abstract" element from being displayed in
both the mega-manual and the PDF version, and 2), brought the
author and look of the first page into line with other YP
manuals.
3. Removed the old PNG file used to display the Yocto logo at
the top of the QS. This file was removed from both the
yocto-project-qs and mega-manual "figures" directories.
4. Added a new "yocto-project-qs-title.png" file to both the
yocto-project-qs and mega-manual "figures" directories.
5. Updated the "qs-style.css" file's .authorgroup element to
match and behave like the other YP manuals. This effectively
correctly displays the title PNG file for the QS.
6. Updated the Makefile area where the TAR files are made for
both the yocto-project-qs and the mega-manual. I had to
substitute in the new PNG file for the QS one and had to
add the title PNG to the mega-manual part.
(From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
(From yocto-docs rev: c031c014bae6d6e4a239a4bcd1e8b9d5d272f851)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Created a new figure for the flow. This involved putting the figure
into the "Figures" directory of both the dev-manual and the mega-manual
and then updating Makefile to include the figure in the TARBALL
variable.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
Added a new figure to support the expanded section on SDK
generation. Figure added to "figures" directory for both
the ref-manual and the mega-manual. Updated Makefile to
include the figure in the TARBALL variable for both the
manuals.
(From yocto-docs rev: 41f78fddfd871fdd4c1c963b98093567d4b4d230)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
| |
(From yocto-docs rev: 0871329d11ddb3626ede0aa334180e75badabc39)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
Created the figure for the BitBake-resident image generation
discussion. Figure added to the Makefile so it is included
in the TARBALLS for ref-manual and mega-manual.
(From yocto-docs rev: 607c88dcf060a804475b2f4b9cf22f2d8172a61d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
The new section on package creation required a new figure.
I added the figure to the TARBALL creation part for both the
ref-manual and the mega-manual.
(From yocto-docs rev: 3e752dd95659282833519bff866adc940a156ba7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
A new figure named configuration-compile-autoreconf.png was
introduced in a new section. Thus, the figure had to be added
to the tarball creation for both the ref-manual and the
mega-manual.
(From yocto-docs rev: aa0967ee49fa5d8053e14e0cc229b47a0e65b1f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
Had to add the patching.png figure to the TARBALL for the
mega-manual and the ref-manual.
(From yocto-docs rev: fe51c2c76f364956683c484527e245a745920dc1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
Created a new section called "BitBake" that will provide an
expanded discussion of the basic YP build process. The
"BitBake" section has a new sub-section called "Source Fetching."
Part of the new section is a new figure named source-fetching.png.
The figure must reside in the "figures" directory in both the
ref-manual and the mega-manual. It must also be listed for each
of these manuals in the TARBALL statement in the Makefile.
(From yocto-docs rev: 41eff3e755a98ff31cadccfb1cd7dfcf569b4d9e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
Applied review comments to the "Images" and SDK sections that
are part of the "A Closer Look at the Yocto Project Development
Environment" section. Comments from Paul. They resulted
in a single figure being removed and split into two new
figures - one for the image part and one for the sdk part.
Some terminology issues were cleaned up in the main sections
as well as the documented variables sections.
Makefile changes involved adding the two new figures and
removing the old combined one.
(From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes [YOCTO #2808]
Added a new section for the closer look at how BitBake creates
images and the SDK installer files. This included the section
itself, a new .PNG figure that had to be added to the figures
directory of both the ref-manual and the mega-manual. Finally,
the Makefile needed to be edited so that the tarballs for the
ref-manual and mega-manual also included the new figure.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
| |
I left off the ".png" part of a figure in the TARBALL statement.
(From yocto-docs rev: e1024da36a94dd3cb8c0679782bedaba4bf2e5dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
| |
Needed to add six new figures to the mega-manual TARBALL and
five figures to the ref-manual TARBALL.
(From yocto-docs rev: 296e356cbd6a65d187a3e3d7905566685580f575)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
|
|
|
|
| |
A new figure was introduced in the ref-manual. This required the
figure to be added to the list for tarball creation for both the
ref-manual and the mega-manual.
(From yocto-docs rev: 4179b6284f9d5fb87dec5d0442f7637b1e15de30)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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 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>
|
|
|
|
|
|
|
| |
(From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
|
|
|
|
|
|
|
| |
(From yocto-docs rev: 1bb975547f509eb9c8364762f8e5040c7ead423a)
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>
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|