Commit Graph

42 Commits

Author SHA1 Message Date
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 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
Timo Mueller 6485078889 documentation/bsp-guide/bsp-guide.xml: Added Title tag
The title of the document used to create metadata for output formats
such as eclipse help.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:30:48 +00:00
Scott Rifenbark eb8c9e1494 Documentation: bsp-guide - Removed all trailing whitespace.
(From yocto-docs rev: 00d9bb4dcce101a77761418c1279ebfb9441b0d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-11 16:15:24 +00:00
Scott Rifenbark a01f335f3d documentation: prepare for 1.4
Made changes to the poky.ent file to change the three variables
needed to build manuals for 1.4.

Made new entries in the manual revision history tables for the
five manuals that have them.  Each entry shows the "TBD" release
coming up.

(From yocto-docs rev: f7f75a238d709698f1582ce22e209c09ee60581b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03 13:52:53 +00:00
Scott Rifenbark f42d97bba7 documentation: Release date updated.
Updated the release month in all the manual revision history
tables to say "October 2012" from "Sometime in 2012".

(From yocto-docs rev: 1fc9313fe6c69db3d8cece6d940f78a2f0dc8386)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-17 17:32:44 +01:00
Scott Rifenbark 26409ca882 documentation/bsp-guide/bsp-guide.xml: Fixed title
the title in the note about production process was technically
wrong. I added in "Yocto Project" as part of the title.

(From yocto-docs rev: c421f02549b8ca203d1c9f747870911c59bda96c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:57 +01:00
Scott Rifenbark 03fd402081 documentation: Fixes to note for mega-manual processing
the notes that say "Due to production processes..." at the start of
each manual contain links to manuals.  the links needed to be formatted
such that the entire <ulink> code and manual name appeared on the same
line so that the sed script can effectively remove the link in the
resulting mega-manual.

(From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:57 +01:00
Scott Rifenbark 0957740660 documentation: Added manual history for 1.3
Added entries for the Manual History table for upcoming 1.3 docs.

(From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31 21:16:53 +01:00
Scott Rifenbark f79aa01630 documentation: Updated Manual Revision Tables again.
After some discussion from Song and Richard, the dates in the
manual revision table has been updated to "April 2012" for the
1.2 release.

(From yocto-docs rev: b3fc2ec7c5aedb8ea0a2d502bdcd7e8f4092ed96)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23 23:04:47 +01:00
Scott Rifenbark 564e311a8d documentation: Manual Revision Tables updated
Five tables updated for the five manuals that have the tables.
Used "May 2012" as the date.

(From yocto-docs rev: 0d4d46ba300c07ff9c73186506be5b409bef9d1b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23 23:04:46 +01:00
Scott Rifenbark 241140d0eb documentation: Added TBD entry to 1.2 manual history table.
There needed to be an entry in all the manual history tables
that indicated this version of the manual is for 1.2 but is
WIP.

Reported-by: Rudolf Streif <rudolf.streif@linux.com>
(From yocto-docs rev: 6792b88af4f0171cfc84e4d77bda871d4af3d36c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-28 16:53:34 +01:00
Scott Rifenbark 7c12cb1183 documentation/bsp-guide: Converted links to use poky.ent variables.
(From yocto-docs rev: 5a95fd07deed0c118529b7890857850308b4b5ab)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:42 +00:00
Scott Rifenbark 7431a70248 documentation: Updated copyright notices to 2012.
(From yocto-docs rev: a270fe40606ccbef5c453bb77f009306a7bdfb93)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:08 -08:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
There are many references to YP documentation throughout the
YP manual set.  They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development.  Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.

This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number.  So for example, all the "latest" occurences
would need to be changed to "1.2".  Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.

(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-11-25 15:24:17 +00:00
Scott Rifenbark 14be63e635 documentation: Updated title pages.
Updated the title pages for the ADT, BSP, Dev, and Ref manuals to
contain the Oct 6 release date for the books.  Also, changed the
author field for the BSP guide to include Tom Zanussi as well
as Richard Purdie.

(From yocto-docs rev: 301da0a5b305e4b332397bb67f6a6a77751991d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:42 +01:00
Scott Rifenbark d02e56fd14 documentation: Changes to Paul Eggleton's edits for various manuals.
Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them.  However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2.  After merging them to my yocto-docs/master
branch I fixed some issues.

(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:38 -07:00
Paul Eggleton 1e18d85170 documentation: set titles for all documents
These documents do not have titles when showing up on the website; set
the title tag value so that they do.

(From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Scott Rifenbark 958c355665 documentation: updated the note in the front matter to use a link specific to manual.
(From yocto-docs rev: 8008a00e188dc0569d0fb6e5cf497637a0b57747)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-20 17:51:58 -07:00
Scott Rifenbark aa764cef07 documentation/bsp-guide/bsp-guide.xml: Added note to title page.
Note mentions possible differences between docs in the released
tarball and docs on the website.  Suggests website for latest
docs.

(From yocto-docs rev: 1b729667498363a5bb451502975b0797796eea0b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:51 +01:00
Scott Rifenbark 306e1a5320 documentation: updated manual history
I added an entry to represent the Yocto Project 1.0.1 Release into
the manual history table for all of the manuals except the Yocto
Project Quick Start, which does not have a table.

(From yocto-docs rev: d2c570b18854b3f15dfb20436a2212f569e96d5f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-13 22:38:04 +01:00
Scott Rifenbark 609e497ba1 documentation/bsp-guide/bsp-guide.xml: Updated Title Page
I updated the revision table for the manuals to have better
wording and to go from oldest to newest top down.

(From OE-Core rev: 7a4f802bb4d12f863a13fc4ba095a3de149aa6df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 16:47:58 +00:00
Scott Rifenbark eccbe890fb documentation/bsp-guide/bsp-guide.xml: Updated revision history on title page.
I updated the revision history on the title page to reflect the upcoming
Release 1.0.  I will likely have to change this as we get nearer the
release so I can be sure of the number and also add meaning release
remarks to the entry.

(From OE-Core rev: 5ba502311221c3a476465d148fcfecf557fbfe79)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-03 16:56:13 +00:00
Scott Rifenbark 5aa6e5251b documentation/bsp-guide/bsp-guide.xml: Updated RP email address
Changed the email address for Richard Purdie in the author title
page to richard.purdie@linuxfoundation.org.

(From OE-Core rev: 86e355f489437c4d20a717617d203a8a5aa1371a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-03 16:56:13 +00:00
Scott Rifenbark efab5b131d documentation/bsp-guide/bsp-guide.xml: Updated copyright
Changed copyright date from "2010" to "2010-2011"

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08:00
Scott Rifenbark 5ca54c6269 BSP guide: Updated the book id.
I updated the string used for the book id from 'poky-handbook' to
'bsp-guide'

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 00c23106d4 Added a new PNG file (bsp-title.png) as the imagedata tag.
Since this manual is about BSP and not Poky as is the Poky Reference
Manual I updated the title page to include the title combined with the
Yocto Project logo.  Updates affect both the PDF and HTLM versions
of the BSP Guide.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:24 +00:00
Scott Rifenbark 890a794e38 Created a new folder to hold the BSP Guide
I created a new sub folder to hold the BSP Guide by itself so there are
three folders now for each of the Yocto manuals: BSP Guide, quick start
and poky ref manual.  The new folder for the BSP guide is 'bsp-guide'.
It contains the bsp.xml file, its own Makefile, a bsp-guide.xml file,
and its own 'Figures' directory.  The 'bsp-guide.xml' file that was
in the poky reference folder was deleted.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-04 20:54:30 +00:00