Commit Graph

37 Commits

Author SHA1 Message Date
Scott Rifenbark 24344d5504 documentation: Updated Manual Notes
Updated the notes on the title page to give the user some
advice for when he searches for the manual and gets old
manuals.

(From yocto-docs rev: 7dedbb67272a18bd768ab5fe637b20a09801d904)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:18 +01:00
Kristi Rifenbark e31d17d2e1 documentation: Updated manual revision table for 2.3.4 release date
(From yocto-docs rev: cbee54f7725fe2a7949e07508e40c22a3dcf1565)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:24:54 +00:00
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 b3e2ecaae2 documentation: Added support for "pyro" name and May release date.
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>
2017-03-24 23:44:03 +00:00
Scott Rifenbark 77afd14e81 documentation: Updated "latest manual" note on title page
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>
2017-02-19 06:59:51 -08: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 b1e4d96e28 documentation: Updated Manual revision table for 2.2
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>
2016-10-11 08:51:22 +01: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 3831ca0dee documentation: Updated release date in manual history tables.
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>
2016-04-06 23:11:59 +01: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 1345195137 documentation: Updated Manual revision tables with "April 2015"
(From yocto-docs rev: a012e34956b8ac2fa7610e264f460bc27bdd66d8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-19 12:38:18 +00:00
Scott Rifenbark 1484e62e5f documentation: Updated the manual revision history tables.
Added an entry for the 1.8 release stating that the release
is slated for sometime in 2015.

(From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879)

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 6c3d1192c7 documentation: Updated release date for manual rev tables.
Added "October 2014" to table for all manuals that have the
table.

(From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-03 14:41:30 +01:00
Scott Rifenbark 95c6c26fba documentation: Updated the manual revision history tables for 1.7
(From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241)

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 0403353623 documentation: Updated all the manual revision history tables.
Set the release date to April 2014.

(From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21 22:47:10 +01:00
Scott Rifenbark 81f7ff34b1 documentation: Fixed "Relased date" for the 1.5.1 entry
Fixes [YOCTO #5857]

I had missed replacing the release date in the manual revision
history tables for the 1.5.1 release.  It was still an estimate.
I have replaced with the actual date of "January 2014"

(From yocto-docs rev: fb9abe0df33a9b551d797ac1b72577931f5f8ce6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:36 +00:00
Scott Rifenbark f762d40db0 documentation: Changed Note for most recent manual
Fixes [YOCTO #5368]

Changes partially address this issue, which is the removal of
tarball installations for poky.  The notes at the beginning of
the YP manuals suggested that the tarball version of a manual
might lag the version found on the website.  Because we are
discouraging installing poky/documentation from a tarball now,
I have re-written the note to be generic and suggest simply that
for the most recent version of the manual associated with the
release, see the manual on the website.

(From yocto-docs rev: a5e96e7eb719e69bbcf2139af2e20230aedc4247)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:09:50 +00:00
Scott Rifenbark fa1ba9b0bf documentation: Updates to Manual revision tables
Updated all six tables for both 1.5.1 and 1.6 releases.  Both
entries need to ultimately be in the 1.6 version of the
manuals.

(From yocto-docs rev: ac1d2cc5686da142562cd674f7fa8908895a27df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:09:49 +00:00
Scott Rifenbark 6b9cff42a8 documentation: Updated Manual Revision History Tables
Placed the release month of October in for the 1.5 release.

(From yocto-docs rev: c0431b2b3115d9687dcb5d3ba37adf6bf4695867)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:55 +01:00
Scott Rifenbark e5dae1b980 kernel-dev: Fixed link in title page to point to new manual.
The stock Note indicating that the user should consult the website
for the latest version of the released manual had a link to the old
kernel-manual.  I have replaced it with a link to kernel-dev.

(From yocto-docs rev: 804e672e42a66aecdbe83ce239433216af10ef8c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:36 +01:00
Scott Rifenbark 91ec8a8988 documentation: Updates to properly build the 1.5 manuals
1. Changed the variables in poky.ent to contain the "1.5"
   string and the "tbd" string for the unknowns.

2. Updated the manual revision history tables so to replace
   the 1.4.1 release entry, which should not be there, to the
   1.5 entry.

(From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 98d2211872 documentation: Set up the 1.4.1 manual set.
1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff.
2. Updated the manual revision tables to have a new entry
   for 1.4.1 release.

(From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22 17:23:38 +01:00
Scott Rifenbark 15699d331c documentation: Updated the release month to April in manual history tables.
(From yocto-docs rev: 3dc4e3db0a76a29c9726d38e3f862940437317c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-10 16:20:54 +01:00
Timo Mueller a41a805500 documentation: Part 1 of 2 updates to integrating docs to Eclipse help.
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>
2013-02-14 17:25:35 +00:00
Scott Rifenbark d36e4792e7 kernel-dev: Added "Maintenance" appendix.
New appendix required adding the kernel-dev-maint-appx.xml
file.  The contents are sections 3.2 and 3.3 from the old
YP Kernel Architecture and Use Manual, which is "Tree
Construction" and "Build Strategy."  According to Darren Hart,
this information should be retained for the few people on
the planet that might ever need it.  In addition to adding
the new file, I had to add the bits to the kernel-dev.xml
manual to support including the appendix when making the
manual.

(From yocto-docs rev: b25e40308080c59c6700e1dce8ebf6a9a2dafbcc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:03 +00:00
Scott Rifenbark 9ba5e61b7a kernel-dev: Updates to support new concepts appendix
Added bits to support building the new kernel concepts
appendix.

(From yocto-docs rev: 6d372bd12288142b09c729f877c1e894f11c7c27)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark b5337adfd8 kernel-dev: Added support for the FAQ chapter.
(From yocto-docs rev: 05162a9462674a35c36676b09987510c94467688)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:13 +00:00
Scott Rifenbark 46b0fc3ec6 kernel-dev: Updated the root file to include the metadata chapter.
(From yocto-docs rev: b31e8928dbfeef3908d8a83a152e6701fa3bbbe0)

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 974ef52d56 kernel-dev: Rough text in for new chapter. Makefile edited.
The raw text for the second chapter is in by section.  This has
no formatting whatsoever.  I also edited the Makefile so that
the new "Common Tasks" chapter would make as part of the manual.

(From yocto-docs rev: 68bcc1e977fbdd7b1a4b448171d1149edc72db51)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:05 +00:00
Scott Rifenbark d0858ccb33 kernel-dev: Updates to get the new kernel-dev manual to make
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>
2013-01-16 15:59:05 +00:00
Scott Rifenbark 6833ec86ac kernel-dev: Edits to set up root .XML file for new kernel-dev manual.
(From yocto-docs rev: 12019f8ddebc78162f4a759c5e84fac314a962ef)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:04 +00:00
Scott Rifenbark 5cbeb84006 kernel-dev: Created file structure for new kernel-dev manual.
(From yocto-docs rev: 25be3ebb7713b875c4ec6e3723961b7dd860295d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:04 +00:00