The original QS (yocto-project-qs) has been retired for the YP
sumo (2.5) release. The manual has been replaced with the
brief, two-page quick build document (brief-yoctoprojectqs).
I needed to create a new title figure for the manual to include
as part of the mega-manual (bypqs-title.png). The figure was
added to the figures folder of both the bried-yoctoprojectqs
and mega-manual book folders. I also removed the old
ypqs-title.png file that was used for the original QS.
Updated the stylesheet doc for the brief build to include a
style using the new title .PNG file.
Updated the mega-manual.xml file to include the brief doc and
exclude the original QS.
(From yocto-docs rev: aadec4a70fa89e4dcd233c337d8971c8353ee26d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual. Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.
(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #12417]
Deleted the appendix.xml file.
Updated the mega manual .xml file to not include
the Mars appendix file.
Updated the sdk-manual.xml file to not include the
Mars appendix file.
(From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76)
Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have added a chapter to the getting-started manual that will
introduce the YP. Just the framework exists at this point.
Changes to the mega-manual.xml file were made to include the
new chapter in that manual as well.
(From yocto-docs rev: 8a52156ac02d9a9a97c5f0cd8dce5f70d2be68d0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also updated the mega-manual.sed file with two lines to process
links in the concepts-manual.
(From yocto-docs rev: 622ce2fc82cbf92351aa2000c3d92bbabafc1d24)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Because the deeper concepts chapter that was in the Getting Started
With Yocto Project Manual was moved to a new Yocto Project Concepts
Manual, I had to delete it from the mega-manual.xml file where it
would be included as a chapter in the getting-started manual.
(From yocto-docs rev: a6847cc90cd0e35e275dd4cf080067ecbe5d4361)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
All of the information from the "usingpoky" chapter in the
ref-manual has been distributed out over the rest of the
YP manual set. Primarily, this information went into the
dev-manual and the overview-manual. Because the chapter is
no more, I had to update the mega-manual.xml to not include that
chapter. Also, had to update ref-manual to exclude the chapter
as part of the Make process.
(From yocto-docs rev: b988cab06d42f0ac2220cefe66949c5ab6cbf803)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The "technical-details.xml" file was for the old chapter four of the
ref-manual. All content in that chapter has been moved to the new
concepts chapter of the overview-manual. I updated the mega-manual.xml
file to not include the old technical-details chapter as part of the
ref-manual. I also updated the ref-manual.xml file to not include the
technical-details.xml chapter when building the ref-manual.
(From yocto-docs rev: c4a88048dc099dbd2d0926a9194d5502fa2f1cfc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section on the x32 psABI topic was in the "technical details"
section of the reference manual. This section combined conceptual
and "how to" information for x32 psABI. I moved the conceptual
information to a new chapter in the overview-manual. I moved the
"how-to" information to a separate topic in the dev-manual. This
resulted in the mega-manual being updated to take on a new chapter
for the overview-manual (overview-concepts.xml). No links were
affected.
(From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Pulling out some introductory information from the old "Introduction"
chapter of the ref-manual has isolated the system requirements and
term definitions sections. I have decided to create a new chapter
for terms as they are a reference item. This leaves system requirements
also alone as a new chapter. So, I dumped the introduction.xml chapter
in favor of the two new chapters.
(From yocto-docs rev: 35c41b3008845c94e10be19b37409b0d1a469ff5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Added a new chapter to the newly created Yocto Project Overview
Manual. This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.
The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area. Consequently, I had to recast all
these links from the different manual.
Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.
Many figures had to be relocated as part of the move as well. This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.
(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
I added all the mechanics for this new "Yocto Project Overview Manual".
For now, the manual builds and publishes into the 2.5 area. I used
"overview-manual" for the folder name. Makefile properly builds the
new manual. The mega-manual.sed file processes links for the new manual.
The mega-manual.xml file includes the new manual. The poky.ent file
includes a new ENTITY link for the overview manual. All pieces are in
place.
With this commit, just an overview chapter exists. The remaining content
needs to be developed.
(From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the way the YP QS looks. The QS now has numbered sections
rather than just formatted section heads. This allows the reader
to better track the hierarchy of the sections. This feature has
been asked for before and I decided it was time to implement it.
One thing though, is I am not generating a full TOC at the head
of the book as is done in the other YP manuals.
Decided to add a manual title .PNG file. This required a new figure
file (ypqs-title.png) that needed to reside in the figures folder of
both the yocto-project-qs and mega-manual. Updates were required in
the Makefile to include the figure. Updates required in the
YP QS style sheet to display the figure. Basically, there were all
kinds of changes to get this title to show up properly in both the
YP QS and in the Mega Manual.
Turned the structure of the YP QS into a book now rather than an
article. This required creating a "qs.xml" file that has the actual
content.
(From yocto-docs rev: ef05f5c7ba2a61ebc4c58873cbbc32d35652659d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made the title page notes consistent across the manual set.
Made the author group information consistent as well. It is better
that authorship is seen as a third party and not tied to Intel
Corporation.
(From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This also affected a link in the dev-manual and some setup stuff
in the mega-manual and sdk-manual.xml file due to a new chapter
being introduced.
This section on the Eclipse stuff is big enough to warrant its
own chapter. I decided to pull it into a separate chapter of its
own.
(From yocto-docs rev: a4b2b605902f09bb200facfabb0a7c355fbf4c87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was misplaced in the dev-manual and really needed to
be in the ref-manual. I created a new chapter that follows the
devtool reference chapter and put the kickstart chapter there.
Links were needed to be fixed up and a new chapter in the
ref-manual named ref-kickstart.xml had to be created.
(From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The string in the manual revision table needed updated across the
set except for the kernel-dev manual.
(From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual. I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual. In truth, the
only things added were a note about devtool not being exclusive
to SDK development.
The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away. The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left. So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual. I had to delete three
figures that were used in the flow. The figures were already
replicated in the sdk-manual. The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.
I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.
(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The chapter on setting up YP has been completely re-written to
move towards a "how-to" manual. This involved touching every
aspect of the chapter. All subsections now have procedures
surrounding set up stuff. There are some development sections that
still need fleshed out.
Many, many links and references in other chapters were affected.
These have been fixed.
A couple style-sheet (*.css) files were also updated to support the
"writernotes" style, which renders paragraph text in red.
(From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to use 2.4 variables and numbering
Updated mega-manual.sed to use "2.4" string for links
Updated all manual revision tables to use "2.4" and
"Usually October, 2017" string.
(From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
"Pyro", respectively.
Manual Head Files - Updated the manual history table with the
May release month.
(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10888]
The YP documentation was missing information on how the major
and minor (point) release process works. I added a new chapter
in front of the "Maintenance" chapter that details the naming
schemes, cadence, and maintenance for YP releases.
(From yocto-docs rev: b486f871e1fb8a6f763510ed385f459fe215fa27)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10076]
The note on the title page for each manual was brief regarding
where to find the latest version of the manual. I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.
(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to the following:
* All manual revision tables to indicate a 2.3 release proposed
for April of 2017.
* Updated the poky.ent file so that all variables needed reflect
2.3 values.
* Updated the mega-manual.sed file so that processing of links in
the mega-manual work for a 2.3 release.
(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8584]
This fix essentially had to document how to add the API
documentation to the standard SDK. The fix required adding a
new appendix to the SDK manual on how to customize that
standard SDK. I could not put just one topic in a new appendix
so I also added a sub-section on how to add indidual packages
to the standard SDK.
Other changes here were the introduction of a new file for the new
appendix, updated the mega-manual.xml file so that it would include
the new chapter when the MM was built. Finally, I added some
cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK
and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the
distro features section on the api-documentation bullet.
(From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added string "October 2016" as the release date.
(From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Due to new chapters in the SDK manual and the movement of the devtool
Quick Reference from the dev-manual to the ref-manual, I had to xinclude
these various chapters in the mega-manual.xml file that builds out the
manual.
(From yocto-docs rev: 8d6fb3d97e6a64b53cfdf66d94d7306babb48378)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Updated poky.ent to have the appropriate 2.2 variables
* Updated all manual revision tables to have a new entry for
2.2 - used "Sometime in 2016" for the date.
* Updated the mega-manual.sed file to process internal links
for 2.2.
(From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated to "April 2016" for all manuals that use this table.
(From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Makefile - Added support for new sdk-manual.
mega-manual - Added the sdk-title.png file to the list of figures.
Modified to support inclusion of the new sdk-manual
into the mega-manual.
poky.ent - Added a new string to support the new sdk-manual.
sdk-manual - Created new sdk-title.png image.
Created new sdk-manual.xml file.
Created sdk-manual customization layers for both
standard build and Eclipse build.
Note that we are pointing to local XSL templates for
and these will change going forward.
Created new sdk-style.css file.
Created three chapter files that are placeholders
at this point.
(From yocto-docs rev: ab591831a97a97d405d13ed75e9fb01e0452c292)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The changes are for the poky.ent file and the mega-manual.sed
file to take care of variables. Also, entries added for the
manual revision table.
(From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These updates included editing the poky.ent file so that
DISTRO and related variables are now 2.0. Also updated all
the title pages to have the manual revision table correct.
Finally, used my email for the manuals.
(From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This involves the following:
* Inserting a new row for all manual revision history tables
to have "October 2015" and 1.9 as the release information.
* Updating the mega-manual.sed file to process links for 1.9
* Updating variables in poky.ent to deal with the 1.9 release
variables.
(From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the reference chapter in so it is included as part of the
mega-manual.
(From yocto-docs rev: 90a6ebabd0657d6dd7381a8c1fc7db5ea8b26a1f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way the mega-manual used 'xinclude' to suck in the other
YP manuals was to suck in the root XML file. The problem with
this was that the root XML file for each subsequent book would
include front-matter information. The front-matter information
included an .authorgroup style, which caused the new mega-manual
title displayed at the very top to be also re-displayed with
a subsequent manual's title. These changes altered the strategy
for using 'xinclude' to pull in the various YP manuals. Rather
than pull in the root XML file for a given manual, individual
chapters are pulled in that comprise a given manual. A slight
side-effect is that chapter numbering is sequential from top to
bottom in the mega-manual, which I suppose is better as it is
being presented as an entire manual anyway.
(From yocto-docs rev: 61cc9f2f92900894ef09ff13e1e92ebe30a17be3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6901]
Added the toaster-title.png file to the mega-manual/figures
folder so the Toaster title would show up in the mega-manual.
Added lines so that the mega-manual would include the Toaster
manual file to the mega-manual.
(From yocto-docs rev: 5a4a67e4f140802da133b7bcb480c84b4a8edb63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in proper front matter for the mega-manual. This effectively
creates a real title for the manual as well as a brief abstract
that explains why this behemoth exists.
(From yocto-docs rev: 26c78f0b00762846a839fbfc9ba969b7aa5d5b58)
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>
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>
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>
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>
This new directory contains the files for the mega-manual HTML
document. Mega-manual is a compilation of all the existing YP
manuals and guides. It is a single HTML file that simply lists
each individual HTML document for the existing YP manuals and
guides. The figures directory contains all the figures (duplicated)
from the individual manuals and guides.
(From yocto-docs rev: 5620c20ea4c7c69c96601b7480471e6166fd9409)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
