Commit Graph

40 Commits

Author SHA1 Message Date
Scott Rifenbark 3a980abd28 documentation: Updated manual history tables.
Added a new entry to support the 1.5.3 release.  Using July 2014
as the release month and year.

(From yocto-docs rev: fcd6046b8b2a5606e77d14cffa0bd2eebbe1748a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18 10:30:31 +01:00
Scott Rifenbark 3decaf2620 documentation: Updated the manual revision history tables for 1.5.2
(From yocto-docs rev: c3674816afea52cc37ae842577f8eebf34d20d69)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-12 20:31:59 +01:00
Scott Rifenbark ed0353828e poky.ent, documentation: Updated manual release dates.
Updated poky.ent to use 2014 as the top-end copyright year.
Updated all the Manual Revision History tables to use January
2014 as the 1.5.1 release date.

(From yocto-docs rev: 885a89231c664ccbd9032c45584aa19dce7c0b38)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-08 13:01:44 +00:00
Scott Rifenbark 29d095ff71 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: d47ff8285a6ba01d721509724641a51aab8da73d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:46:42 +00:00
Scott Rifenbark d72b558cd9 poky.ent, documentation: Updates for building 1.5.1 release.
Changed variables in poky.ent to support building 1.5.1.

Added Manual revision entry to all manuals with that table for
the 1.5.1 release.

(From yocto-docs rev: a1c3196199437c3a7cfdf86e4f78b806c66b6385)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-11-01 17:46:41 +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 c94fd49bfc documentation/dev-manual/dev-manual.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:27:21 +00:00
Scott Rifenbark 72d01bf43d documentation: dev-manual - Removed all trailing whitespace.
(From yocto-docs rev: d117584a589460412a7fc4df15512b0d9c9448c7)

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 b31fa1bbbe documenation: dev-manual - re-ordered chapters.
The "Common Tasks" chapter is better suited as the last chapter in
this manual.  So I moved the development workflows up a chapter.

(From yocto-docs rev: 19f0a6411c065388b5bd0083338b164b43baff0e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-10 15:18:11 +01:00
Scott Rifenbark e0f0335467 documentation: dev-manual, bsp-guide - Removing/Moving Appendix A
The kernel example appendix is being removed.  This broke a lot
of links.  For now I have moved the information into a new section
called "Patching the Kernel".  I have preserved the information
by adding the old appendix file as kerne-appendix-orig.xml.

(From yocto-docs rev: 994235a69362dfb0114ef9001ea7f2f2e2fdc5c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-10 15:18:11 +01:00
Scott Rifenbark 1f0a3c56ba documentation: dev-manual - Removed Appendix A.
This appendix is antiquated and needed removed.  The BSP
development example is now in the BSP guide where it talks
about running the yocto-bsp script.

(From yocto-docs rev: 892ff450d79a7564a72f11eb7510d349ca71d47a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-04 14:08:20 +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 2c6f72d01a documentation/dev-manual/dev-manual.xml: fixed so mega-manual works
I moved "the" outside of the generated HTML link so that the sed
script will process this part of the manual correctly for the
HTML mega-manual.

(From yocto-docs rev: 3bdf7c7dc4478f2a435cbc84a8a815daf7130660)

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 b84383a7e1 documentation: Fixed references to the YP Dev Manual
The references to the YP Development Manual were inconsistant.
These references were fixed.

(From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:54:56 +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 aa3a201629 documentation/dev-manual: Converted to use poky.ent
I converted the hard links to use the variables as established
in the file poky.ent.

Also, Cleaned up some bad text in the term "Yocto Project Files."
Looks like a cut-and-paste problem.

(From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:43 +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 f908723bc6 documentation: top-level manuals edited for new structure
I updated dev-manual.xml to include the new common tasks file
'dev-manual-common-tasks.xml' and updated poky-ref-manual.xml
to not have the file 'extended.xml'.  This reflects the new
chapter swap between the YP reference manual and the YP
development manual.

(From yocto-docs rev: 978e3be4f20b0a95cf124ce1a9136016a3e71da1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:50 -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 7e8ae603b5 documentation/dev-manual/dev-manual.xml: updated note for latest documentation.
The link does not exist yet.

(From yocto-docs rev: e74440f299eee8372090a749a301b10871eb297f)

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 343fc6476b documentation/dev-manual/dev-manual.xml: Repositioned note.
Put the note about manual differences in the legalnotice area.
this produced a better looking note.

(From yocto-docs rev: 8d44a5fba7c52d5798758467e93c9c64e48d512a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:50 +01:00
Scott Rifenbark 896c9decee documentation/dev-manual/dev-manual.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: 1675c31aa02a4daed356af4ea9c78d493a9a2597)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:50 +01:00
Scott Rifenbark c28a1896e9 documentation/dev-manual/dev-manual.xml: updated files to the book
I removed the cases chapter and added an appendix for kernel example.

(From yocto-docs rev: 60c8ec3444c08e94468ff349b676652c7f6ff0cd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:48 +01:00
Scott Rifenbark 5492fa39a0 documentation/dev-manual/dev-manual.xml: Added the new appendix for BSP.
Updated the list of files to include dev-manual-cases-bsp-appendix.

(From yocto-docs rev: 0756e69e25fb4008fae592f3e06b03b3d773e0a8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:44 +01:00
Scott Rifenbark ca967534f6 documentation/dev-manual/dev-manual.xml: re-ordered the chapters for the make.
(From yocto-docs rev: 0fa74f9339128d8817e7d26de5d48a54772d7274)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:23 +01:00
Scott Rifenbark 1523da3564 documentation/dev-manual/dev-manual.xml: Added chapter
I added the dev-manual-model.xml chapter to the list of chapters
to include.

(From yocto-docs rev: 513faf68cdf338b28020119266148287ea459916)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:23 +01:00
Scott Rifenbark 55d9b846cc documentation/dev-manual/dev-manual.xml: Initial file with new name.
(From yocto-docs rev: cd67481e8a6424b424a15dbbcbed8d39f1f6d689)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:23 +01:00