* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date
(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was using "2.8" throughout the manual set instead
of "3.0". Updated all aspects to "3.0".
(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.
(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12399]
Fixes made to have the BitBake User Manual included in the build
of the mega-manual. I placed this manual at the end of the
mega-manual. Following changes made:
* Makefile - Modified to include two PNG files. All PNG files
in a given manual are listed in the area that makes
the mega-manual so that the tarfile is complete.
* mega-manual.xml - Updated the front wording to tell the user
that the BitBake User Manual is included in the
Mega-Manual. Also, added a last section to actually
include the bitbake-title.png file and the *.xml
files. Note that I could not add the title figure
from the same figures folder of the local "bitbake"
folder. Would not include in the build. So, I
pulled the file from the figures folder of the
mega-manual, which is what I do for all the other
book titles used in the mega-manual.
* mega-manual.sed - Modified to clean out the old stuff that
had been carried along for older books not
supported for the release. Modified to include
link processing for the newly included BitBake
User Manual.
* New Figures - Moved copies of the "bb_multiconfig_files.png"
and "bitbake-title.png" figures into the
figures folder of the mega-manual.
(From yocto-docs rev: 78a1ae0ca92bb7f8a9d3a32a320299371d0ed361)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to have variables for 2.7.
Updated mega-manual.sed file to use "2.7" string.
Updated all <manual>.xml Manual History Tables to use "TBD"
(From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No need to escape out quote characters in a .sed file. Also, using
the @ character is cleaner.
(From yocto-docs rev: f87ca83a6faf5b772d719cd03d6fa0a9b21174bb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using the "@" character to de-specialize the "/" character.
This change makes the file more readable.
(From yocto-docs rev: d15c9ce6cc365768677cdd40a8859bb96aad7dc4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the script to process the overview-manual strings
found in the mega-manual. These changed due to the folder
chaning from "getting-started" to "overview-manual".
Additionally, I discovered a single occurrence of a linked
reference to the mega-manual that was in the mega-manual.
This is not ideal. That link needs to be a link in the
ref-manual where it originates. However, the link in the
mega-manual should not link to itself. That link needed
processing just like all top-level book links in the
mega-manual. The link should be removed. I added a single
substitution operation at the end of the file to handle this
lone case within the mega-manual.
(From yocto-docs rev: 57ebdb1cb10a4df0d69316d1f116d7804199ae90)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The variabe for the "getting-started" manual goes away and is
replaced by this one for the new "overview-manual."
(From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the documentation, the manual "Getting Started With
Yocto Project" was used. The manual now is called "Yocto Project
Overview and Concepts Manual".
(From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This manual will not exist. I deleted the two lines that process
links in the mega-manual for the concepts-manual
(From yocto-docs rev: 49530e16b19b8f24782c15fe7daf68e0e0444e39)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use when referencing the getting-started
manual. The manual's name does not include the word
"Manual". So, I cleaned this up across the manual set and
also in the mega-manual.sed file, which was incorrectly
processing the links to that manual that do not target a
specific section.
(From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The escaping of the double quote characters is not necessary
in the mega-manual.sed file, which processes the links in that
large HTML document. I have removed them.
Authored-by: Aurelio Jargas <aurelio@aurelio.net>
(From yocto-docs rev: 640a52c74750b9148116171cfa8a2cca388f6d7c)
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>
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual." So, I had to hand fix these.
Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead. Those were fixed.
(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)
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>
I neglected to change the string for matching purposes in the SDK
line when the SDK manual title changed. This was causing links to
that manual where there is no specific #<target> to not be resolved
correctly.
I also removed a redundant line for the yocto-project-qs manual. It
was appearing in two places.
(From yocto-docs rev: dcc0d5a98af93eded676e7b4cb684f60d2cf9d3a)
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>
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>
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>
* 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>
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>
The previous commit did not fix the problem. This one does.
(From yocto-docs rev: d19c2096018db0127d11814ddcba919ad469e428)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added logic to string search and fix links in the Toaster Manual
part of the mega-manual. This keeps the links correct for the
mega-manual.
(From yocto-docs rev: f93b5a187984949129db16b638935b678fd344a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a Python script that a developer can run to create a .patch
file that when submitted to oe-core will update the documentation.conf
file. The update will bring the [doc] file variable descriptions
in line with what is in the ref-manual variables file.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: f9dca76a8d9be3dcdbde9229beb03f0ba3701485)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced the 1.7 strings with 1.8 so that all links in the
mega-manual are self-contained and properly resolve.
(From yocto-docs rev: 49f4b02c999ff2c3c78111673f6760f5fde2b82e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Discovered that the sed file was processing the bitbake-user-manual
just like the others, which was wrong. the BB manual is not included
in the mega-manual so the links there need to be left alone. The fix
included specially creating substitution lines to handle all the YP
docs while excluding the BB manual.
(From yocto-docs rev: f2c99c6a66c3f67ab226f317dfae195294ddafea)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This line was left out for links with no target. The line is now
in there.
(From yocto-docs rev: 5a27a32261628b7d4f60981cfe624f08d8cf1535)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had commented this out with the previous commit but decided
to completely eliminate it with this one.
(From yocto-docs rev: 088f783bb12d29499d1b5da36a3c7a682a7d79d8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The kernel-manual folder is depricated post 1.4 release. I commented
out the line that processes links for that folder.
(From yocto-docs rev: 1b84448020f75fa2d3c9c12d8ae72ba2a7e7db99)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This sed script needs to process the correct version of the
release. I changed from 1.4 to 1.5.
(From yocto-docs rev: 8a27243191408b0bc58803d21a6853283d0b3c6a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
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>
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>
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>
Added this file to the tools directory. It is used from the Makefile
when making the mega-manual. The file processes all the appropriate
<ulink> tags so that they are converted to <link> tags and the user
is not vectored off to an external HTML file.
(From yocto-docs rev: da2ad62a160c22f785e8237439494716e4c023cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
