Commit Graph

32 Commits

Author SHA1 Message Date
Scott Rifenbark 6ad7b41c2d documentation: Updates to support a 2.3.4 point release
poky.ent - changed variables for 2.3.4
mega-manual.sed - updated "2.3.3" string to "2.3.4"
<manual>.xml - updated manual revision list for a "TBD 2018" release date.

(From yocto-docs rev: cddf2f339ed29bfa58964f271922de4203d3d1ef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:24:54 +00:00
Scott Rifenbark 5e552100b0 documenation: Prepared docs for a 2.3.3 point release
poky.ent - updated variables
mega-manual.sed - replaced '2.3.2' with '2.3.3'
<book>.xml - updated all the manual revision tables to use a 2.3.3
             release of January 2018:

(From yocto-docs rev: 375b229399f77696c742e0aa3626792a24fecff2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-22 22:22:53 +00:00
Scott Rifenbark d05391a7d4 documentation: Preparation for 2.3.2 release
poky.ent -> Changed variables
mega-manual.sed -> replaced 2.3.1 with 2.3.2
*.xml files -> Updated manual revision tables for 2.3.2 and
               September 2017

(From yocto-docs rev: ce5bc517148f872e49d617fbfda7ae81c56efa04)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:56 +01:00
Scott Rifenbark 484237aa97 documentation: Prepared 2.3.1 release variables and dates
poky.ent - updated variables for 2.3.1
mega-manual.sed - exchanged "2.3.1" for "2.3" for links
<manual>.xml - updated manual revision tables to use
               "June 2017" as the release date for 2.3.1

(From yocto-docs rev: 01d60d08a0c7371b8f7476f45fca89226caec680)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22 09:18:49 +01:00
Scott Rifenbark 6ce2cdcc93 documentation: Updates to support developing 2.3 YP docs
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>
2016-11-16 10:38:42 +00:00
Scott Rifenbark 6c5fea2171 documentation: Prepared manuals for a 2.2 release.
* 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>
2016-06-06 22:53:35 +01:00
Scott Rifenbark 9796cbbf4f mega-manual.sed: Removed adt-manual processing
(From yocto-docs rev: 4cbf38bf860ae0c21d87e7b761ad0d0d4b0a70ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:58 +01:00
Scott Rifenbark 8bdc7071ee sdk-manual: Initial Manual framework
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>
2016-01-07 12:13:45 +00:00
Scott Rifenbark ccc830df1d documentation: Prepare for 2.1 builds
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>
2016-01-07 12:13:45 +00:00
Scott Rifenbark 1944d28000 documentation: Updated files to support 2.0 release.
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>
2015-10-21 23:06:32 +01:00
Scott Rifenbark 02881a8d0b documentation: Preparation for 1.9 builds
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>
2015-04-15 15:57:18 +01:00
Scott Rifenbark d6d2dd5c9e tools: A real fix for thos mega-manual.sed file for Toaster.
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>
2015-04-02 20:30:46 +01:00
Scott Rifenbark 810106afbd tools: Updated the mega-manual.sed file to include the Toaster manual.
(From yocto-docs rev: 36f9685837da5d202372933bfa895e8a3724dd5c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-02 20:30:45 +01:00
Scott Rifenbark 6d512bd691 mega-manual: Updated sed file to include the toaster manual.
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>
2015-02-17 15:16:58 +00:00
Scott Rifenbark eafdfbfb37 tools: Added new file update-documentation-conf
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>
2015-02-17 15:16:52 +00:00
Scott Rifenbark 51f6cb03b0 mega-manual.sed: Updated to support the 1.8 release.
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>
2014-11-04 10:28:30 +00:00
Scott Rifenbark 4767787613 ref-manuala: Updates to support links to BB manual
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>
2014-07-21 19:06:52 +01:00
Scott Rifenbark 418af200fb mega-manual.sed: Added line to process profile-manual.
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>
2014-07-03 13:57:07 +01:00
Scott Rifenbark 9943e33d22 mega-manual.sed: Changed the version string to 1.7
(From yocto-docs rev: 4ca53b0968aa678f52acda229422b5e420a8e91a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13 07:50:57 +01:00
Scott Rifenbark 3d26d97be4 tools/mega-manual.sed: Updated to build for 1.6 release.
(From yocto-docs rev: 580e6fbbe9c55b91a8dc6c257b615b0507de3c50)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:09:48 +00:00
Scott Rifenbark a44fc491e0 mega-manual.sed: Deleted kernel-manual line.
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>
2013-08-13 13:18:37 +01:00
Scott Rifenbark 68752d79e4 mega-manual.sed: Removed the processing for kernel-manual
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>
2013-08-13 13:18:37 +01:00
Scott Rifenbark 36828be835 tools: Bumped version to 1.5
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>
2013-05-31 08:19:20 +01:00
Timo Mueller e29a40c98b documentation/tools/eclipse-help.sed: Fix whitespace
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:41 +00:00
Timo Mueller a11f23b4bc documentation/tools/eclipse-help.sed: Processes external links for eclipse html files
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>
2013-02-14 17:21:29 +00:00
Scott Rifenbark c9c0029c9b tools: Updated SED file that processes links for mega-manual
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>
2013-01-16 15:59:08 +00:00
Scott Rifenbark a44106a0db tools: Updated the SED file that processes links in the mega-manual.
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>
2013-01-07 14:43:27 +00:00
Scott Rifenbark 7aa9df2972 tools: updated the .sed file that processes the links in mega-manual
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>
2013-01-07 14:43:27 +00:00
Scott Rifenbark e4bb6b7be8 documentation/tools/mega-manual.sed: Processes external links in mega-manual
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>
2012-09-04 12:55:01 +01:00
Richard Purdie 0be66f0e88 documentation/tools: Add comments to script
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 15:07:05 +01:00
Richard Purdie 37eb4e2b93 documentation/handbook: Tweak Makefiles and paths after path changes
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 12:14:28 +01:00
Richard Purdie 2208328791 handbook: Move into documentation directory
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 11:55:59 +01:00