Commit Graph

95 Commits

Author SHA1 Message Date
Scott Rifenbark ed6a5495a1 documentation: devtool upgrade and quick ref changes to mult manuals
Did the following:

 * Added the devtool upgrade flow to the SDK manual.
 * Removed the devtool Quick Reference from the dev-manual and
   added it as a new chapter to the ref-manual.
 * Made sure all the links and cross-references work now with the
   moved material.
 * Updated the Make file so that the manual set builds correctly
   regarding the new chapter in the ref-manual.
 * Created cross-referencing notes in both the sdk-manual and the
   dev-manual to the newly located devtool Quick Reference chapter.

(From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28 15:02:32 +01:00
Scott Rifenbark d2084cc95a Makefile: Removed adt-manual support
(From yocto-docs rev: 84abe03de1cff7952b5d0428e7433f094dde2b02)

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 4c5157f7dc ref-manual: Resolving a conflict
(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:08 +00:00
Scott Rifenbark 5a647013e5 sdk-manual, mega-manual, Makefile: Added new figures
Added a devtool add and devtool modify flow digram.  Updated
the Makefile to support those figures in the tarball creation.

(From yocto-docs rev: b40692065262dee0209329886b6e3a743c32b1bd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark 32629e01d6 Makefile: Resolving a conflict
(From yocto-docs rev: 221b8eeee23841395b6323da0893156346dead6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark 7ab8afa7a5 Makefile: Added the ".png" part to a figure I forgot.
I left off the file extension when I added a new figure to the
SDK manual.  This caused the tarball to fail.

(From yocto-docs rev: f1984b00b44ad7f1890adecdb7e2f6dd4af5b96c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark ad7a994cbb Makefile: Updated the figure list for the mega-manual.
Including three figs for Toaster manual.

(From yocto-docs rev: c41f9859b6cfc4e34b8e0d0e812fad0b8dd44540)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:07 +00:00
Scott Rifenbark 6996a1cd3d Makefile: Added sdk-environment.png to figure list for SDK Manual
(From yocto-docs rev: 5576b989539c9fee989a1c75d142d89c62c4da76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:06 +00:00
Scott Rifenbark 77594c08d7 mega-manual, Makefile: Added support for three new toaster figures.
These figures were added through a patch and needed to also
be local to the figures directory in the mega-manual.

Also, the Makefile must list the figures for the TAR file.

(From yocto-docs rev: 6904899f2df8c531f1d6f7c61482d737b9e93971)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23 21:56:06 +00:00
Scott Rifenbark b2b22d5eda dev-manual, mega-manual, Makefile: Added support for new upgrade flow
Created a new figure for the devtool upgrade flow.  Put the figure
in the "figures" folder of the dev-manual and the mega-manual.
Updated the Makefile to include the new figure when creating
Tarball of the dev-manual and the mega-manual.

(From yocto-docs rev: 4b504f6f179ca7c7e9a69f23fc25b1f33ced8e44)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:13 +00:00
Scott Rifenbark 1eecaea70d dev-manual, mega-manual: Added new figure for devtool modify flow
(From yocto-docs rev: 2472ab38e0badd50d4e30e161bb56edba4cfbdb2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 17a21e6f73 Makefile, dev-manual, mega-manual: Added new figure support
Created a new figure for devtool add flow.  Added support
for it in the Makefile.  The figure, as usual, needs to
reside in the figures directory in both the dev-manual and
the mega-manual.

(From yocto-docs rev: 2040a31b806fdade060f7a4182a09673b76db7b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03 17:40:12 +00:00
Scott Rifenbark 8bdc7071ee sdk-manual: Initial Manual framework
Makefile - Added support for new sdk-manual.
mega-manual - Added the sdk-title.png file to the list of figures.
              Modified to support inclusion of the new sdk-manual
              into the mega-manual.
poky.ent - Added a new string to support the new sdk-manual.
sdk-manual - Created new sdk-title.png image.
             Created new sdk-manual.xml file.
             Created sdk-manual customization layers for both
             standard build and Eclipse build.
             Note that we are pointing to local XSL templates for
             and these will change going forward.
             Created new sdk-style.css file.
             Created three chapter files that are placeholders
             at this point.

(From yocto-docs rev: ab591831a97a97d405d13ed75e9fb01e0452c292)

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 8fc90a7aeb Makefile: Updated the make file to not create toaster-manual pdf
(From yocto-docs rev: a9babbc10603a2dd984fb633e85f3b3d93e43ac7)

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 ab23dd967e yocto-project-qs and others: Rewrite of the QS
This was a complete re-write of the YP Quick Start in an attempt
to streamline it, remove unecessary detail, and make it flow better
with the examples.  In doing so, many manuals were affected due to
section headings being renamed, information being moved, etc.  Here
is a list of the changes by manual:

Makefile - Removed two figures from TARFILE list for the
           yocto-project-qs.

           Added building-an-image.png to the ref-manual TARFILE list.

           Added using-a-pre-build-image.png to the adt-manual TARFILE
           list.

           Repositioned 'eclipse' in the adt-manual TARFILE list.

adt-manual: Fixed a cross-reference so that it goes to the new
            'Building Images' section that is within the YP QS.

            Added new section 'Example Using Pre-Build Binaries and
            QEMU' to hold the information that was formerly in YP QS.

dev-manual: Removed a cross-reference into the YP QS that promised how
            to configure the most efficent build.

            Changed a cross-reference into the YP QS from 'The Packages'
            to 'The Build System Packages'.

            Changed a cross-reference into the YP QS from 'Building an
            Image' to 'Building Images'.

            Changed a text reference from the YP QS to the adt-manual.

            Moved the bit about getting YP files by using the YP website
            from the YP QS to the dev-manual.

            Changed a cross-reference into the YP QS from 'Using Pre-Built
            Binaries and QEMU' to 'Example Using Pre-built Binaries and
            QEMU', which was moved to the adt-manual.

ref-manual: Changed a cross-reference into the YP QS from 'What You
            Need and How You Get It' to 'Setting Up to Use the Yocto Project'.

            Moved the note about if your system has oss4-dev in the
            packages area in the YP QS to the appropriate area in the
            ref-manual.

            Moved the introduction information regarding building an image
            along with the figure from YP QS to the ref-manual's section on
            building images.

toaster-manual: Changed a cross-reference into the YP QS from 'What You
                Need and How You Get It' to 'Setting Up to Use the Yocto
                Project'.

yocto-project-qs: Complete rewrite that changed many section headings and
                  removed much detail, which was placed in other manuals.

(From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28 18:02:32 +01:00
Scott Rifenbark 2b822400f4 documentation: Updates to try to fix CentOS docs build errors
The docs are not building on CentOS and we think it is due to the
XSL templates being called for the Eclipse parts.  I located all
the "current" templates and switched them out for "1.76.1" version
as are used by the mainstream doc builds.

(From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:13 +01:00
Scott Rifenbark 1f63333b7f Makefile: Added figures to the mega-manual TARFILE list
Added the three Toaster Manual figures to the list of
mega-manual figures so they will be included in the tarball
generated for mega-manual.

(From yocto-docs rev: 2190bc43dfc20c0c0ef5da82c85570f9294e1788)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:11 +01:00
Scott Rifenbark a089bed49f Makefile: Added additional PNG files to toaster TARFILE list.
(From yocto-docs rev: b662062cd575f187918f6841983d5682426b266e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01 12:59:10 +01:00
Scott Rifenbark a0999ab4df toaster-manual: Updated tar contents to not include the PDF file.
(From yocto-docs rev: b80931a3930ac4eda8daec37dc3de0f1d4d3844e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:59 +00:00
Scott Rifenbark ab2007dc4e Makefile: Removed default PDF creation of Toaster Manual.
(From yocto-docs rev: 7cceb7b0a0f53a4207070ff369bec8a3a6ceb135)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:58 +00:00
Scott Rifenbark cd31b931e3 documentation: Support files to build Toaster Manual.
Changes to the files that support building out and publishing
the Toaster User Manual:

 * poky.ent - Added a new variable YOCTO_DOCS_TOAST_URL that can
   be used in other manuals to link to sections with the Toaster
   User Manual.

 * Makefile - Added a section of code to build out the Toaster
   User Manual.  Currently, no eclipse support is added as I don't
   think we want to cross into that development environment with
   Toaster.

(From yocto-docs rev: 35ea6656265d61024d5db36a534a7250f783956a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:57 +00:00
Scott Rifenbark 0a54446d2f mega-manual, Makefile, poky.ent: Added front matter to mega-manual
Put in proper front matter for the mega-manual.  This effectively
creates a real title for the manual as well as a brief abstract
that explains why this behemoth exists.

(From yocto-docs rev: 26c78f0b00762846a839fbfc9ba969b7aa5d5b58)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:56 +00:00
Scott Rifenbark 4a1ea28ce9 documentation: First draft devtools.
Completed draft of the new devtool material.  This commit affects
some linking and figures across the YP doc set.

* Added the build-workspace-directory.png file to both the
  dev-manual and the mega-manual.

* Updated the Makefile to include the new figure in the TARFILE
  for dev-manual and mega-manual.

* Re-did the section organization to pull the quilt and finding
  source file out of the "Modifying Source Files" section.

(From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:55 +00:00
Scott Rifenbark b83c526667 Makefile: Modified to make 'pdf' target not part of 'all'
By default, making a file will not include the PDF version of the
manual.  Some manuals you can't do a PDF version anyway (i.e.
yocto-project-qs and mega-manual).  The PDF versions do not need
to be part of the mainstream make process.  If someone wants these
they can take the extra step of doing 'make pdf DOC=<manual>'.

(From yocto-docs rev: 16f605350adb1b252b94e921faf282d0634cefb6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17 15:16:47 +00:00
Robert P. J. Day 63e44521ef Makefile: Clean ups to the Makefile.
* small number of typos fixed.
* documentation corrected in a couple places.
* for most part, reduce line lengths to 80 for printing.

I was going to fix just a couple typos, then figured that while i was
there, might as well do some cleanup, mostly in the area of reducing
line lengths to 80 where possible for printing. feel free to comment
on any other possible aesthetic fixes, i can add them and resubmit.

(From yocto-docs rev: cfe4c061d8691e128933b81693aa42c809ef5486)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06 14:27:00 +00:00
Scott Rifenbark 4f0fa9224a Revert "yocto-project-qs, mega-manual: Conformed to YP book set"
This reverts commit 914c482bd89071ab34b3381e3bd8065f871cc047.

I had to revert this change because it broke the footnote behavior.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-19 22:36:14 +00:00
Scott Rifenbark c576556033 yocto-project-qs, mega-manual: Conformed to YP book set
I discovered some artifacts and inconsistencies with how the YP
Quick Start was made.  I made the following changes:

1. Changed the structure of the QS from "article" to "book"
   as it is a separate book.  This change doesn't fix anything
   but it does bring the XML file closer to passing validation.

2. Removed the <abstract></abstract> tag.  This tag was in place
   simply to display the PNG file for the Yocto logo in the upper
   right part of the first page.  After turning the QS into a
   book from an article, the title could be displayed as a PNG
   file similar to the other books.  This change solved two issues:
   1) removed the empty "abstract" element from being displayed in
   both the mega-manual and the PDF version, and 2), brought the
   author and look of the first page into line with other YP
   manuals.

3. Removed the old PNG file used to display the Yocto logo at
   the top of the QS.  This file was removed from both the
   yocto-project-qs and mega-manual "figures" directories.

4. Added a new "yocto-project-qs-title.png" file to both the
   yocto-project-qs and mega-manual "figures" directories.

5. Updated the "qs-style.css" file's .authorgroup element to
   match and behave like the other YP manuals.  This effectively
   correctly displays the title PNG file for the QS.

6. Updated the Makefile area where the TAR files are made for
   both the yocto-project-qs and the mega-manual.  I had to
   substitute in the new PNG file for the QS one and had to
   add the title PNG to the mega-manual part.

(From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-19 22:36:14 +00:00
Scott Rifenbark 1bd23c8679 dev-manual, mega-manual, Makefile: Added new recipe creation flow figure.
(From yocto-docs rev: c031c014bae6d6e4a239a4bcd1e8b9d5d272f851)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>

Created a new figure for the flow.  This involved putting the figure
into the "Figures" directory of both the dev-manual and the mega-manual
and then updating Makefile to include the figure in the TARBALL
variable.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-02 13:16:10 +00:00
Scott Rifenbark 43c10b90ad ref-manual, mega-manual, Makefile: New figure added for sdk
Fixes [YOCTO #2808]

Added a new figure to support the expanded section on SDK
generation.  Figure added to "figures" directory for both
the ref-manual and the mega-manual.  Updated Makefile to
include the figure in the TARBALL variable for both the
manuals.

(From yocto-docs rev: 41f78fddfd871fdd4c1c963b98093567d4b4d230)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:47 +01:00
Scott Rifenbark 7b0c340926 Makefile: Updated ssh push string.
(From yocto-docs rev: 0871329d11ddb3626ede0aa334180e75badabc39)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:44 +01:00
Scott Rifenbark da7a072aa0 dev-manual, ref-manual, Makefile: Added image generation figure
Fixes [YOCTO #2808]

Created the figure for the BitBake-resident image generation
discussion.  Figure added to the Makefile so it is included
in the TARBALLS for ref-manual and mega-manual.

(From yocto-docs rev: 607c88dcf060a804475b2f4b9cf22f2d8172a61d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:44 +01:00
Scott Rifenbark 3420b3a759 Makefile: Added new figure for package creation.
Fixes [YOCTO #2808]

The new section on package creation required a new figure.
I added the figure to the TARBALL creation part for both the
ref-manual and the mega-manual.

(From yocto-docs rev: 3e752dd95659282833519bff866adc940a156ba7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:30 +01:00
Scott Rifenbark fff996f0d4 Makefile: Added figure to the ref-manual and mega-manual
Fixes [YOCTO #2808]

A new figure named configuration-compile-autoreconf.png was
introduced in a new section.  Thus, the figure had to be added
to the tarball creation for both the ref-manual and the
mega-manual.

(From yocto-docs rev: aa0967ee49fa5d8053e14e0cc229b47a0e65b1f9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:30 +01:00
Scott Rifenbark bc1739193a Makefile: Updated with new figure.
Fixes [YOCTO #2808]

Had to add the patching.png figure to the TARBALL for the
mega-manual and the ref-manual.

(From yocto-docs rev: fe51c2c76f364956683c484527e245a745920dc1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:29 +01:00
Scott Rifenbark a0eec0d86f ref-manual, Makefile: New section on BitBake for expanded build
Fixes [YOCTO #2808]

Created a new section called "BitBake" that will provide an
expanded discussion of the basic YP build process.  The
"BitBake" section has a new sub-section called "Source Fetching."

Part of the new section is a new figure named source-fetching.png.
The figure must reside in the "figures" directory in both the
ref-manual and the mega-manual.  It must also be listed for each
of these manuals in the TARBALL statement in the Makefile.

(From yocto-docs rev: 41eff3e755a98ff31cadccfb1cd7dfcf569b4d9e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:29 +01:00
Scott Rifenbark 93c76f4c65 ref-manual, mega-manual, Makefile: Updates to expanded dev section
Fixes [YOCTO #2808]

Applied review comments to the "Images" and SDK sections that
are part of the "A Closer Look at the Yocto Project Development
Environment" section.  Comments from Paul.  They resulted
in a single figure being removed and split into two new
figures - one for the image part and one for the sdk part.

Some terminology issues were cleaned up in the main sections
as well as the documented variables sections.

Makefile changes involved adding the two new figures and
removing the old combined one.

(From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:47 +01:00
Scott Rifenbark 4b23d26063 ref-manual, mega-manual: New section for images/SDK
Fixes [YOCTO #2808]

Added a new section for the closer look at how BitBake creates
images and the SDK installer files.  This included the section
itself, a new .PNG figure that had to be added to the figures
directory of both the ref-manual and the mega-manual.  Finally,
the Makefile needed to be edited so that the tarballs for the
ref-manual and mega-manual also included the new figure.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:47 +01:00
Scott Rifenbark f32e019ab9 Makefile: Corrected figure file name.
I left off the ".png" part of a figure in the TARBALL statement.

(From yocto-docs rev: e1024da36a94dd3cb8c0679782bedaba4bf2e5dc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:45 +01:00
Scott Rifenbark b57aa070e1 Makefile: Added new figures to the TARBALL variables.
Needed to add six new figures to the mega-manual TARBALL and
five figures to the ref-manual TARBALL.

(From yocto-docs rev: 296e356cbd6a65d187a3e3d7905566685580f575)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:44 +01:00
Scott Rifenbark 95c46ae567 Makefile: Added figure cross-development-toolchains.png
A new figure was introduced in the ref-manual.  This required the
figure to be added to the list for tarball creation for both the
ref-manual and the mega-manual.

(From yocto-docs rev: 4179b6284f9d5fb87dec5d0442f7637b1e15de30)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-21 14:26:31 +01:00
Richard Purdie 72fdc8ed09 yocto-docs: Fixup a couple of merge issues
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:30:09 +00: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 fcb3952ef6 documentation/Makefile: Fix copying of figures folder
When calling the eclipse target twice without calling clean in between
the figures folder was copied as a subfolder of the existing figures
folder. This patch fixes the copy command to correctly copy the
figures folder.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:41 +00:00
Timo Mueller 6c057d0841 documentation/Makefile: Clean up eclipse target and update help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:38 +00:00
Timo Mueller 239b469820 documentation/Makefile: Added conversion of links to other documentation parts.
The script tools/eclipse-help.sed is used to convert links that
point to other documentation parts. This avoids having to leave
the eclipse help center when clicking these links.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:29 +00:00
Timo Mueller 108ffcf310 documentation/Makefile: logic to make all for yocto-project-qs and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the yocto-project-qs. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:29 +00:00
Timo Mueller 72639b4a58 documentation/Makefile: Support for making Eclipse HTML yocto project qs manual
This target will generate eclipse help for the yocto-project-qs using
the yocto-project-qs-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:28 +00:00
Timo Mueller bbe7cb4770 documentation: Move yocto-project-qs global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:27 +00:00
Timo Mueller f4bcee695c documentation/Makefile: logic to make all for poky-ref-manual and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the poky-ref-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:24 +00:00
Timo Mueller c6af0b969c documentation/Makefile: Support for making Eclipse HTML poky ref manual
This target will generate eclipse help for the poky-ref-manual using
the  poky-ref-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:15:08 +00:00