Commit Graph

26 Commits

Author SHA1 Message Date
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 9bdc18a820 documentation/poky-ref-manual: Converted to use poky.ent variables.
Fixed all the hard links to use appropriate variables from the
file poky.ent.

(From yocto-docs rev: 9a6267d0d843dc47c1171eba6200387901b77df4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:44 +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 a191e6e048 documentation/poky-ref-manual: New chapter introduced
Long-term strategy for the YP Reference Manual is that it contains
reference material and not "how-to-information".  A step in this
direction is to isolate any discussions on components and other
areas of YP that need talked about.  So to start with, I have created
a new chapter for now named "Technical Details" that so far has
a discussion of some components and shared state.  This is a
step in the direction of making this manual a reference manual and
not a "how to" manual.

Changes included removing redundant material from the 'usingpoky.xml'
chapter and also adding the new chapter 'technical-details' into the
'poky-ref-manual.xml' file used for the make.

(From yocto-docs rev: 567823392d903016d314ae9fcc1b4d7abf59d9ae)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-16 16:58:38 +00: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 df815c1543 documentation/poky-ref-manual/poky-ref-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: 5061f9e8b3cfb66b2ed17befc9c4c4d8b875f4eb)

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 4ff1f64f1b documentation/poky-ref-manual: Added new title graphic
I have removed the multi-colored POKY image that was used for
the title of the Poky Handbook.  The image I put in here is in
line with the other graphics used as titles for our Yocto Project
documentation.  To accomplish this I had to create and add a new
PNG file named poky-title.png.  I placed this image in the figures
folder.  I removed the poky-ref-manual.png file (old figure).
I also had to alter the Makefile to use the new figure as part of the
tarball.  Finally, I had to alter the HTML style sheet (style.css)
to include the new file.

(From yocto-docs rev: 6c44fca054c1c105daea6fa42f89a7f78a6d12cd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:16 +01:00
Scott Rifenbark 5215126ef2 documentation/poky-ref-manual/poky-ref-manual.xml: Updated rev-history table
Updated the revision history table for the manual.

(From OE-Core rev: 65c7bb8489de654cc02dcff0dfff21754e2e5ce8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-04 17:28:05 +01:00
Scott Rifenbark 98d2039a33 documentation/poky-ref-manual/poky-ref-manual.xml: Updated title page
Updated the title page by adding a new revision entry for the manual.
Not sure of the current revision numbering scheme so I reset it to
Revision 1.0 to match that of the release.

(From OE-Core rev: 1604f6543eba3757b08bff96e75d045b809de544)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-18 17:22:21 +00:00
Scott Rifenbark fa0792896c documentation/poky-ref-manual/poky-ref-manual.xml: updated copyright date
Changed the copyright upper date from 2010 to 2011.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-02-25 09:10:28 -08:00
Richard Purdie 81e29fbfac poky-ref-manual: Fix my email address
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-01-06 15:43:25 +00:00
Scott Rifenbark c272830d8c documentation/poky-ref-manual/poky-ref-manual.xml: Changed the revision date to 24 November 2010
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:16 -08:00
Scott Rifenbark 2cf5aafc28 Poky Reference Manual: Changed source location of the bsp.xml file
Because BSP chapter (bsp.xml) is identical to the single file used
in the BSP Guide (also bsp.xml but in the bsp-guide folder) I have decided
to change where the Poky Reference Manual get the bsp.xml file.  This commit
causes it to get the file from the bsp-guide folder instead of an identical
but separate bsp.xml file local to the poky-ref-manual folder.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Richard Purdie e445fcf5dd poky-ref-manual: Drop non-commercial clause
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-11-13 22:13:00 +08:00
Richard Purdie be132ca72a docmentation/poky-ref-manual: Remove unused Indexes title
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-11-04 21:17:29 +00:00
Richard Purdie 5dfe9b7d4d documentation: Update copyright to the Linux Foundation
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:51:04 +01:00
Scott Rifenbark 2ccf2b358d Re-installed the Poky Handbook image at the top of the manual
I could not get the Yocto Project logo to appear correctly in the book
after the title.  I also decided that since Poky is by no means
going away that this book should have that image associated with it
as it is the Poky Reference Manual.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-10-27 07:51:02 +01:00
Richard Purdie 4999f78874 documentation/pokt-ref-manual: Update with Yocto branding
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-27 07:50:33 +01:00
Richard Purdie 80eba26fb1 documentation/poky-ref-manual: Various tweaks to the text
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 15:07:06 +01:00
Richard Purdie 95cf36fbd1 documentation: Complete poky-handbook -> poky-ref-manual rename
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 12:45:09 +01:00