Commit Graph

192 Commits

Author SHA1 Message Date
Scott Rifenbark
a36e4fea7a sdk-manual, mega-manual: Updated devtool add and upgrade figures
Took out the $TMPDIR part for the output and left more generically
as "Build Output".

(From yocto-docs rev: 90b3c468dbea19c87340bd234ffe1b263ffa1e4f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
1b8867ad08 sdk-manual, mega-manual: Updated the devtool upgrade flow diagram.
Added more detail at the top for how the local recipe interacts
with the Upstream Source.

(From yocto-docs rev: fea704bc485c53bf27ce43f5d1d491bf652ddc9c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
464af1a042 sdk-manual, mega-manual: Updated devtool add flow diagram
Added more detail on how the upstream source or files from
srctree are located.

(From yocto-docs rev: 11c4679ee91afbb96a7ea82f6e32c90b5e3a0d66)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
9435650a71 sdk-manual: Updated devtool add workflow section.
Had to update the figure to use "Upstream Source" labels and
fix a wrong "devtool edit-recipe" command. That new figure went into
both figures folders for the sdk-manual and mega-manual areas.

Provideds some cleaner wording.

(From yocto-docs rev: b55ccf14a9a4b8948a920f0942da1fdda93b2e9e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15 11:26:38 +01:00
Scott Rifenbark
8d011018b0 dev-manual: Removed "newbie" chapter.
This chapter only had the stuff about submitting a defect against
YP and making a change to YP.  I moved that information into the
common tasks chapter as it is "how-to" information.  Removal of this
chapter alse required that the mega-manual.xml file be updated to
not include the chapter.

(From yocto-docs rev: 4421b1585c21a6f7862525ba972f7e765626066e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:05 +01:00
Scott Rifenbark
372e47e927 documentation: Removed release date ENTITY
Now that 2.5 has released, I replaced the ENTITY variable used for
the moving month and year with the actual release month and year
(i.e. May 2018).

(From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:04 +01:00
Scott Rifenbark
e20dc4814b overview-manual, mega-manual: Updated the sdk figure
Added the manifest files to the figure and the associated variables.
Also added the test files.

(From yocto-docs rev: cfba55462d1c37ef2ff6454890da64a40f9c3607)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
d4ba120a80 overview-manual, mega-manual: Updated the Images figure
I needed to add some italic formatting for variable type strings.

(From yocto-docs rev: afc6d2d10081f9e9d940075c03b3e704b37cf13b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
f71afe3613 overview-manual, mega-manual: Updated image generation image
The figure for image generation of the BitBake process
needed some enhancing.

(From yocto-docs rev: fc978663a7962d1515d4f47abe8ae522b9e24ce1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
ee2e1a0399 overview-manual, mega-manual: Updated SDK generation image
The image needed a little bit of clean up.

(From yocto-docs rev: d4fb680be194b7f9b192e06f0081a09504649633)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:03 +01:00
Scott Rifenbark
fb0b55eca4 overview-manual, mega-manual: Updated package splitting figure
More changes to the "analysis-for-package-splitting.png" figure.
I needed to work in "do_populate_sysroot" task and several
STAGING_DIR_* variables.

(From yocto-docs rev: fcb88024a7dfff1b6cca49770f67bf4c1f548362)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
dfa62e1d56 overview-manual, mega-manual: Updated the config/compile figure
The figure had the wrong hierarchy for the "image", "recipe-sysroot",
and "recipe-sysroot-native" folders.  Moved out a level.

(From yocto-docs rev: e1f45b666b1cd589cee9c9ae6dba01467b991ef9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
18012d8276 overview-manual, mega-manual: Updated the package splitting figure.
Figure was out of date.

(From yocto-docs rev: 5b56862ec39fc05299cd6d468f13f75b74c3b800)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
1f52760a51 overview-manual, mega-manual: Updated Config and Compile figure
The "configuration-compile-autoreconfig.png" figure was badly
out of date.  It was not showing the two sysroot directories
and did not use the $BPN variable.  I have updated the figure
and placed in both the overview-manual/figures area and the
mega-manual/figures area.

(From yocto-docs rev: dba3b2b65f18870229dcb3dbcb8fadc099165894)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:02 +01:00
Scott Rifenbark
381cfb71e1 sdk-manual, mega-manual: Updated devtool modify workflow diagram
Added detail for the step one.  Clearer.

(From yocto-docs rev: ef95d547180ce53fade7a3764f8d362422472c7a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:01 +01:00
Scott Rifenbark
02aa4d3ec4 overview-manual: Updated the "patching.png" figure
The figure had a bad "PN" variable being used in the "S" directory.
This needed to be changed to "BPN".

(From yocto-docs rev: beafc55eb3646ecb96929e44538de952207f0b76)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
c5fbbdbde3 overview-manual, mega-manual: Updated source-fetching.png figure
The figure was incorrect. Replaced the PN variable with BPN for
the "S" directory.

(From yocto-docs rev: 440edcdae932a83b6c32b51e85d97178a77b4bed)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
d420ddaf4f mega-manual: Updated the package-feeds.png file
This image was out of date.

(From yocto-docs rev: 061f2766217a6a3914c14e7bfcf09e2c03f73165)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
92de2a42c3 documentation: Added ENTITY variable to track a release date and year
(From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:18:00 +01:00
Scott Rifenbark
bbd6856b2f overview-manual, mega-manual: Updated figures
Updated the layer-input.png and source-input.png figures.
Had to trim them so they were tighter in the figure.  Also,
updated some context in the source-input.png figures.

(From yocto-docs rev: cad644af48b0a1cb2baeb8d2649b9aa7ccbdeda5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
ae5e39c4d6 overview-manual, mega-manual: Updates to layers discussion for build flow
The "Metadata, Machine Configuratrion, and Policy Configuration"
section discusses the three types of layers fed into the OpenEmbedded
build system workflow figure.  I updated the figures and text
supporting this discussion.  The figure had to be moved to the
mega-manual/figures folder also.

(From yocto-docs rev: 39dd671333f7b3df616920aab08e01c926deca1c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
7f2615b124 overview-manual, mega-manual: Updated user-configuration.png image
This image was out of date.  I updated it.

(From yocto-docs rev: feb287a72201363c43607508d2e8f1da3993f93f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
f0bd4e42a4 overview-manual, mega-manual: Removed bitbake workflow figure
This version of the figure was not as cool looking as the other
version, which is preferred.  I have removed it.

(From yocto-docs rev: ed0346b00ee6b47d90efedd1dd69e4a92a42afe9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:59 +01:00
Scott Rifenbark
8961b3d9c8 overview-manual: Updated title .PNG file
The file was stretching beyond the rendered display window such
that part of the Yocto Logo was missing.  Also had to place the
updated .PNG file in the mega-manual/figures folder.

(From yocto-docs rev: 5b73c54fcb2c3f60aee2ff7dc19c4aad102aa505)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:55 +01:00
Scott Rifenbark
f476125b50 poky.ent: Added YOCTO_DOCS_OM_URL entity
The variabe for the "getting-started" manual goes away and is
replaced by this one for the new "overview-manual."

(From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:46 +01:00
Scott Rifenbark
11ea5291a2 mega-manual: removed chapters from concepts manual
these chapters were sucked into the getting-started manual but
now are no longer even needed there.  The chapters are
organizational for the old concepts-manual and provide nothing
for the getting-started.

(From yocto-docs rev: dd97d06039e3fd6bcbbccafa99f4d29ce041ae70)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:45 +01:00
Scott Rifenbark
6fb8ac6894 mega-manual: Removed the concepts-manual.
The two chapters have been integrated into the current
getting-started manual.  Concepts manual is no longer in
existence.

(From yocto-docs rev: f8ee299901acb61d0e638ce9e36f30c5924f36d4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:45 +01:00
Scott Rifenbark
52a0499dfc documentation: Added brief-yoctoprojectqs to mega-manual
The original QS (yocto-project-qs) has been retired for the YP
sumo (2.5) release.  The manual has been replaced with the
brief, two-page quick build document (brief-yoctoprojectqs).

I needed to create a new title figure for the manual to include
as part of the mega-manual (bypqs-title.png).  The figure was
added to the figures folder of both the bried-yoctoprojectqs
and mega-manual book folders.  I also removed the old
ypqs-title.png file that was used for the original QS.

Updated the stylesheet doc for the brief build to include a
style using the new title .PNG file.

Updated the mega-manual.xml file to include the brief doc and
exclude the original QS.

(From yocto-docs rev: aadec4a70fa89e4dcd233c337d8971c8353ee26d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:43 +01:00
Scott Rifenbark
01d53451fb Documentation: Updated Manual Notes
I did some re-wording to account for when the user does a web
search for a manual and the search returns an ancient version
of the manual.  Many times the user is oblivious of this fact
and is trying to use a version of the docs that don't come close
to matching the version of the YP.

(From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:42 +01:00
Kristi Rifenbark
da0ebd28f6 sdk-manual: Removed Mars Appendix
Fixed [YOCTO #12417]

Deleted the appendix.xml file.
Updated the mega manual .xml file to not include
the Mars appendix file.
Updated the sdk-manual.xml file to not include the
Mars appendix file.

(From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:17:41 +01:00
Scott Rifenbark
bb0b966827 bsp-guide: Updated BSP development flow figure.
This figure was out of date.

(From yocto-docs rev: 8b649ab3c4667a45f263818c2532b18f2dae9464)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:12 +01:00
Scott Rifenbark
bf839ab5d6 getting-started, mega-manual: Updated YP website page image.
(From yocto-docs rev: 7c0d710a20246c305a0131f030696b036b950774)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
96f4ac3d6c getting-started, mega-manual: Updated two figures
Had to update the umbrella YP figure and the Poky figure.  The
figures changed on the website so this gets them back in sync.

(From yocto-docs rev: f7f1a689a847ab4a01106eadacfccb4bec6c4b01)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-25 09:41:11 +01:00
Scott Rifenbark
68823387c3 getting-started, mega-manual: Added reference distro poky section
Added the new section "Reference Embedded Distribution (Poky)"
section to the getting-started manual.  The new section required
a new figure.  I had to add the figure to the figures folder of
both the getting-started and mega-manual books.  Updates to the
Makefile to include the new figure as part the tarfiles created
for each book.

(From yocto-docs rev: e5f44e17d4c1e55b6f229cc3745727e439b5bcb7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-03-03 08:35:24 +00:00
Scott Rifenbark
4b3ebf00dc getting-started, mega-manual: New content for intro chapter
Created content for "What is the Yocto Project" section.
Involved a new figure that had to be shared in the mega-manual
figures folder.

(From yocto-docs rev: 72c18abd11587f4d78848afb8a71ff7f4a0e76d0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:32 +00:00
Scott Rifenbark
31f0dda70b getting-started, mega-manual: Added new GS chapter
I have added a chapter to the getting-started manual that will
introduce the YP.  Just the framework exists at this point.
Changes to the mega-manual.xml file were made to include the
new chapter in that manual as well.

(From yocto-docs rev: 8a52156ac02d9a9a97c5f0cd8dce5f70d2be68d0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:32 +00:00
Scott Rifenbark
27072387fa concepts-manual: Updated toolchain figure to use "*_ext
(From yocto-docs rev: 88bf1a438f7a7323f1b7275d3d7bf715d4973569)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:31 +00:00
Scott Rifenbark
d1249c2ba8 mega-manual: Added concepts-manual so it can be made
Also updated the mega-manual.sed file with two lines to process
links in the concepts-manual.

(From yocto-docs rev: 622ce2fc82cbf92351aa2000c3d92bbabafc1d24)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Scott Rifenbark
1c4908a1fb concepts-manual, mega-manual: Added title fig for concepts-manual.
(From yocto-docs rev: c932704d29bd0a065a28675859d5b6f09d8e87e5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Scott Rifenbark
31bd483368 mega-manual.xml: Removed the getting-started-concepts.xml file
Because the deeper concepts chapter that was in the Getting Started
With Yocto Project Manual was moved to a new Yocto Project Concepts
Manual, I had to delete it from the mega-manual.xml file where it
would be included as a chapter in the getting-started manual.

(From yocto-docs rev: a6847cc90cd0e35e275dd4cf080067ecbe5d4361)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:30 +00:00
Scott Rifenbark
ae06e04cd2 documentation: Created new "Getting Started" manual.
Creation involved removing the overview-manual and replacing it
with the getting-started manual.  All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set.  I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".

The style sheet for the new manual needed updating to display the
new .PNG image for the title page.  The mega-manual file had to
be updated to include the files.  The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.

(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
30b91e6d89 documentation: Removed "usingpoky" chapter from ref-manual
Fixes [YOCTO #12370]

All of the information from the "usingpoky" chapter in the
ref-manual has been distributed out over the rest of the
YP manual set.  Primarily, this information went into the
dev-manual and the overview-manual.  Because the chapter is
no more, I had to update the mega-manual.xml to not include that
chapter. Also, had to update ref-manual to exclude the chapter
as part of the Make process.

(From yocto-docs rev: b988cab06d42f0ac2220cefe66949c5ab6cbf803)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:29 +00:00
Scott Rifenbark
9b4575b508 ref-manual: Removed the "technical-details.xml" file
Fixes [YOCTO #12370]

The "technical-details.xml" file was for the old chapter four of the
ref-manual.  All content in that chapter has been moved to the new
concepts chapter of the overview-manual.  I updated the mega-manual.xml
file to not include the old technical-details chapter as part of the
ref-manual.  I also updated the ref-manual.xml file to not include the
technical-details.xml chapter when building the ref-manual.

(From yocto-docs rev: c4a88048dc099dbd2d0926a9194d5502fa2f1cfc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:28 +00:00
Scott Rifenbark
e2060287db overview-manual, ref-manual, dev-manual: Moved x32 stuff
Fixes [YOCTO #12370]

The section on the x32 psABI topic was in the "technical details"
section of the reference manual.  This section combined conceptual
and "how to" information for x32 psABI.  I moved the conceptual
information to a new chapter in the overview-manual.  I moved the
"how-to" information to a separate topic in the dev-manual.  This
resulted in the mega-manual being updated to take on a new chapter
for the overview-manual (overview-concepts.xml).  No links were
affected.

(From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
60cfd0785b ref-manual: Separated terms into separate chapter
Pulling out some introductory information from the old "Introduction"
chapter of the ref-manual has isolated the system requirements and
term definitions sections.  I have decided to create a new chapter
for terms as they are a reference item.  This leaves system requirements
also alone as a new chapter.  So, I dumped the introduction.xml chapter
in favor of the two new chapters.

(From yocto-docs rev: 35c41b3008845c94e10be19b37409b0d1a469ff5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
29ae3d668c mega-manual: Updated sdk-manual figure used
I failed to copy the updated sdk-manual title figure to the
mega-manual/figures directory when the sdk-manual title had changed.
This was causing the title of the sdk-manual in the mega-manual
to render as the old one.

(From yocto-docs rev: cb111620cdce90d8f2f7e14a918a2307e81fe705)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
b797db0db4 documentation: Created new YP Overview Manual
Fixes [YOCTO #12370]

Added a new chapter to the newly created Yocto Project Overview
Manual.  This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.

The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area.  Consequently, I had to recast all
these links from the different manual.

Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.

Many figures had to be relocated as part of the move as well.  This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.

(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
bc6a19d6a7 overview-manual: Added new "overview" manual to YP doc set
Fixes [YOCTO #12370]

I added all the mechanics for this new "Yocto Project Overview Manual".
For now, the manual builds and publishes into the 2.5 area.  I used
"overview-manual" for the folder name.  Makefile properly builds the
new manual.  The mega-manual.sed file processes links for the new manual.
The mega-manual.xml file includes the new manual.  The poky.ent file
includes a new ENTITY link for the overview manual.  All pieces are in
place.

With this commit, just an overview chapter exists.  The remaining content
needs to be developed.

(From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14 15:25:27 +00:00
Scott Rifenbark
3716b1f51e yocto-project-qs, mega-manual: Overhaul of the QS
Changed the way the YP QS looks.  The QS now has numbered sections
rather than just formatted section heads.  This allows the reader
to better track the hierarchy of the sections.  This feature has
been asked for before and I decided it was time to implement it.
One thing though, is I am not generating a full TOC at the head
of the book as is done in the other YP manuals.

Decided to add a manual title .PNG file.  This required a new figure
file (ypqs-title.png) that needed to reside in the figures folder of
both the yocto-project-qs and mega-manual.  Updates were required in
the Makefile to include the figure.  Updates required in the
YP QS style sheet to display the figure.  Basically, there were all
kinds of changes to get this title to show up properly in both the
YP QS and in the Mega Manual.

Turned the structure of the YP QS into a book now rather than an
article.  This required creating a "qs.xml" file that has the actual
content.

(From yocto-docs rev: ef05f5c7ba2a61ebc4c58873cbbc32d35652659d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:08 +00:00
Scott Rifenbark
24503ed3f5 documentation: Set up for "sumo" (YP 2.5) Release.
poky.ent - updated variables
<manual>.xml - updated manual revision tables
mega-manual.sed - replaced "2.4" with "2.5" for links.

(From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:20 +00:00