1
0
mirror of https://git.yoctoproject.org/poky synced 2026-07-16 15:57:04 +00:00

27 Commits

Author SHA1 Message Date
Scott Rifenbark 15c05fc10c documentation: Updated manual history tables for 5.0.2
The 5.0.2 poky release (Yocto Project 1.0.2) required that the
manual history tables be updated.

(From yocto-docs rev: 784e000b9b381e63b453d2b461876611a047ba72)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-20 22:35:17 +00:00
Scott Rifenbark 2c24e6b9b9 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: 5260548a799b4d11942ee0539903f4ea85569894)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-20 22:35:17 +00:00
Beth Flanagan a02537187f documentation: [YOCTO #1025] build system for docs
These changes fix the following issues:

1. Multiple Makefiles. There really is no need for this.
2. Unable to maintain more than one version of the docs on the webserver.

This is a quick fix to enable the above.
In order to build the documentation, at the top level, issue a:
make all DOC=<doc directory name>
make all DOC=kernel-manual

Also, some changes need to occur on the webserver to fully
incorporate these fixes.
http://www.yoctoproject.org/documentation/
The docs are now published to:
http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name>

The main page should be changed to point not only to the current doc release,
but also to the prior releases. This will enable us to maintain prior release
documentation without stomping over it when we publish new docs. Also, we'll
need to repoint the yocto-quick-start link to yocto-project-qs. Or rename
documentation/yocto-project-qs/* to support the website naming.

(From yocto-docs rev: b5cb0801691dbedfa9d3733a6b62450c8a674fa0)

Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-20 22:35:16 +00:00
Scott Rifenbark d1c356ad3d documentation/adt-manual/figures/yocto-project-transp.png: removed file
This figure is not used in the manual.  I removed it.

(From yocto-docs rev: 44cab823ee4b5b1d298d2b99eea847b62a2fbe07)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-20 22:35:14 +00:00
Scott Rifenbark 14c9af0056 documentation: Makefile corrections to support web server structure
The web server directory structure for the post 1.0 releases was changed.
Also, the creation of a new 1.0 area in the web structure was retroactively
created.  this broke the five make files for publishing documents to the web.

I fixed all five files so they now push to the 1.0 area only.  The fix included
hard-coding the 1.0 directory structure.  I also set them up to be a little more
generic.

(From yocto-docs rev: d2cd8f1165b0cc995fc322a7d836de0902da7614)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-14 00:39:51 +01:00
Scott Rifenbark 4825604977 documentation/adt-manual/Makefile: Updated publish
Updated the publish statement so that the HTML and PDF files will
be published to the Yocto Project website.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2011-05-06 17:44:24 -07:00
Scott Rifenbark a3ed4e19e1 documentation/adt-manual/adt-eclipse.xml: Fixed URL with pokylinux.org
Substituted 'pokylinux.org' with 'yoctoproject.org' in an URL
to locate the OProfile viewer and server.

(From OE-Core rev: 6e2553b07be5f06a68f0967775111d7598d9404f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-06 17:44:19 -07:00
Scott Rifenbark 16c10b7a8d documentation/adt-manual/adt-prepare.xml: Fixed URL for nightly builds
There was a stray "0.9" in an URL for the Yocto source downloads.
I changed it to 1.0.

(From OE-Core rev: 82890a85c0422aa6b081497be394aa756da567b2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-06 17:44:19 -07:00
Scott Rifenbark ce08910d62 documentation/adt-manual/adt-eclipse.xml: Fixed link to autotools.
The link to autotools was incorrect.  It had 'www' in the URL
when it should not have.  it is now
'http://download.eclipse.org/technology/linuxtools/update/'

(From OE-Core rev: 56965da0631d4619282b5548fc19118429183507)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-06 17:44:19 -07:00
Scott Rifenbark a6620f2fcf documentation/adt-manual/Makefile: Added PDF file to the tarball
(From OE-Core rev: f30f044355bfe4a1c7b08a201b813afd7cf4bddb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-06 17:44:17 -07:00
Scott Rifenbark 8e4021a890 documentation/adt-manual/adt-eclipse.xml: Updated repo URL for Eclipse Plug-in
Updated the URL that points to the Yocto Eclipse Plug-in to
http://www.yoctoproject.org/downloads/eclipse-plugin/1.0.

(From OE-Core rev: 6657ee7563efecdaa091ef614c5c1e20a2a4665e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-06 17:44:17 -07:00
Scott Rifenbark 8b6416db1e documentation/adt-manual/adt-prepare.xml: Added instruction for building ADT tarball
I added a note in the "Installing the ADT" section (2.1) saying that
if you need to build the ADT tarball you can use
'bitbake adt-installer'.  I also changed the location of the
toolchain from '...yocto-0.9' to '...yocto-1.0'.  Finally,
I changed the host sub-directory in the toolchain directory
from 'i586' to i686'.

(From OE-Core rev: 18124c5065fc570e672d068e915e0f476d20379c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-25 17:40:53 +00:00
Scott Rifenbark 51316230ba documentation/adt-manual/adt-manual.xml: Updated front matter
Changed the revision history box for the manual to state the release
and the release date.

(From OE-Core rev: 15f5307f78899a10358ef426cadf5bc792d11d88)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 17:46:48 -07:00
Scott Rifenbark 80c4ba0e03 documentation/adt-manual/adt-eclipse.xml: Re-inserted Autotools plug-in requirement.
Jessica flip-flopped on the need for the Autotools plug-in that was
removed from the manual.  I have re-inserted the instructions for adding
this plug-in in as part of the Eclipse set up.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 17:46:48 -07:00
Scott Rifenbark d065ae7311 documentation/adt-manual/adt-eclipse.xml: Specified qemu options outside of brackets.
Section 4.1.3.4 discusses custom options for when you want to run
a QEMU image.  Jessica felt that we needed to stress the fact that
the options "serial", "nographic", and "kvm" must all appear outside
of the angled brackets.

(From OE-Core rev: 845770e12b6ed51db3179f42de6b8deacdff5093)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:16 -07:00
Scott Rifenbark f6185c6d85 documentation/adt-manual/adt-eclipse.xml: Removed Autotools plug-in requirement
Section 4.1.2 lists plug-ins that need to be installed prior to installing
the Yocto Plug-in for Eclipse.  I removed the Autotools plug-in
requirement per Jessica Zhang's instructions.

(From OE-Core rev: 94e3971c95e0549a0857f07e1a38d7b7628f0022)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:16 -07:00
Scott Rifenbark 0d4aa19918 documentation/adt-manual/adt-command.xml: Initial draft of command line chapter
This is the initial draft of the Using the Command Line chapter.

(From OE-Core rev: 76bbb867d6e4e9c49c9d4a2d9c453d0cdf692c44)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:16 -07:00
Scott Rifenbark 4dfed39284 documentation/adt-manual/adt-eclipse.xml: Initial draft for Eclipse chapter.
This is the initial draft of the Eclipse chapter.

(From OE-Core rev: 44512573d62fa5e209bf227d6811f9a94ec42372)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:16 -07:00
Scott Rifenbark fc6863bea9 documentation/adt-manual/adt-package.xml: Initial file
This file is the initial XML file for the chapter on optionally
customizing the development packages installation.

(From OE-Core rev: 2e3d29d493d6a3be006e80e75e41a0ff9ad29564)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:16 -07:00
Scott Rifenbark b4af02bcc4 documentation/adt-manual/adt-prepare.xml: Initial draft of preparation chapter
This commit is the initial draft of the preparation chapter (chapter 2).

(From OE-Core rev: c32b215eb37828cd31c0c9ba288c2216fcd034de)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:16 -07:00
Scott Rifenbark 811b28ae39 documentation/adt-manual/adt-intro.xml: Initial text
This commit is the initial text for the introduction chapter.

(From OE-Core rev: 7c0899aa6d712e373bd1a2df1fb52dcf3a87b2fe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:15 -07:00
Scott Rifenbark 55b141c756 documentation/adt-manual/style.css: Changed PNG file in the title page style
The .aurthorgroup style uses a 'background-image' item to add the
book title image.  This had to be changed to 'figures/adt-title.png'
from 'figures/kernel-title.png' since it is for the ADT manual.

(From OE-Core rev: 4c9dda2ac52139f67dc8e461c9f68a5d97d4690f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:15 -07:00
Scott Rifenbark fbe5fdcd05 documentation/adt-manual: cleaned up labels in chapter files
The initial chapters were failing to make due to duplicate section
identifiers that were created when I copied in the original files.
I gave each of the five chapter files (adt-command.xml, adt-eclipse.xml,
adt-intro.xml, adt-package.xml, and adt-prepare.xml) unique identifier
tags.

(From OE-Core rev: d30460c835c51dcc9301bcd848ceda29ba9ceeb6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:15 -07:00
Scott Rifenbark a2075d255b documentation/adt-manual/Makefile: Initial Makefile
These edits take the Makefile from the version I copied over from
the Kernel manual to create the initial version for the ADT Manual.

(From OE-Core rev: 50c61a4fe2f4ad65d6934a3ec3799e6a64709ed3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:15 -07:00
Scott Rifenbark 7ea36613da documentation/adt-manual/adt-manual.xml: Initial file
This is the initial file that the Makefile calls.  The changes in this
commit reflect edits taking it from the copied kernel manual version.

(From OE-Core rev: a7c2c126e4ab12e4ba13cd4cfad70b6556739bc5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:15 -07:00
Scott Rifenbark e4021e2d21 documentation/adt-manual/figures: Added title PNG file, deleted kernel title PNG file.
I added the title PNG file and removed the existing (copied)
kernel title PNG file.

(From OE-Core rev: a4a9c47c1bd1e53652f73cc76f781f1c5df8adcc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:15 -07:00
Scott Rifenbark dfbc6b2d28 documentation/adt-manual: New file structure for ADT Manual
I have added a new directory to documentation named adt-manual.
This directory holds a Figures folder, and the 9 files needed
for the ADT manual.  The book consists of five chapters:
adt-intro, adt-prepare, adt-package, adt-eclipse, and adt-command.
There is also a adt-manual.xml file called by the Makefile.
There is also a style.css file.  And finally, a adt-manual-customization.xsl
file to control numbering.

(From OE-Core rev: ac2c8848bbefcf7d24192573904baaef87c67382)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-03-16 08:08:14 -07:00