Creation of a PDF version of the YP Quick Start is not supported.
The <mediaobject></mediaobject> code appears in the manual for
that purpose only. It is ignored during HTML generation. Thus,
I have removed it from the file. The image is actually displayed
through the <authorgroup> definition, which is located in the
CSS stylesheet.
(From yocto-docs rev: 322ae6450dfac9b2054b33334898a078fdd20902)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
The DocBook type at the top of the file indicated chapter
when the actual block of XML is article. I changed it to article
to be consistent.
(From yocto-docs rev: 5350426c11abc2fa4b1418a2d215cd8814745ef9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the example that creates a new BSP layer by using the yocto-bsp
script, the final step 6 could be interpreted as the script
creating the new layer in "poky". Even though the sentence is
technically correct, sloppy reading could mis-interpret it. I updated
the sentence so that nobody will be confused.
(From yocto-docs rev: 7c2bed2aa6f8c189ed9cabff6e4d4d9557238702)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #6158]
Updated the style scheet file to format glossary variables in
such a way to allow for a PNG file of standard size to be
displayed below each variable. Right now, the PNG file is a
generic placeholder. Each variable displays a PNG file.
Updated each variable to include that PNG file.
(From yocto-docs rev: 24b7b847b7093022a49a014395df0c3a8c019331)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5400]
Per Martin Jansa, added some information in the bullet item that
talks about the tools and the cases that can cause issues when
tuning things by machine or architecture.
(From yocto-docs rev: e8e47828df65abdc18bbd681c47719a7df77b00f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5400]
I applied some review edits to this section as suggested by
Richard Purdie.
(From yocto-docs rev: a1898cf65537e732e0e42605bb28d636077e7f56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5600]
Added a <info></info> tag pair with a short description of the
variable to each variable in the glossary. The short description
is what will be used in the documentation.conf file. Scripting
from engineering will pick up the variable description
automatically. The information between the tags does not
appear in the HTML or PDF output.
(From yocto-docs rev: 57fb9100e377a96c330be20613c5895b25910022)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5400]
This is the first draft of a new section on multi-machine builds.
(From yocto-docs rev: a47fd17295d943bff482a0747f3b2e69831aa985)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The LTTng Documentation website has been updated to actually
have extensive documentation now. Previously, in the profile-manual,
we were stating that documentation did not exist, which was true
at the time of writing. I updated the section to link to the
main LTTng documentation website and altered some other text in
the section appropriately.
Additionally, I found and corrected a couple spelling errors in
this chapter.
(From yocto-docs rev: 6e03bd6b90726904a1ac54b8f16f6554b4bb22b8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced the 1.7 strings with 1.8 so that all links in the
mega-manual are self-contained and properly resolve.
(From yocto-docs rev: 49f4b02c999ff2c3c78111673f6760f5fde2b82e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added an entry for the 1.8 release stating that the release
is slated for sometime in 2015.
(From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor wording changes and a new section added for local.conf
QEMU changes. Also, reordered some sections.
(From yocto-docs rev: 65207b6afa6df7d82cd3482d61f10b308da6fac7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the section to account for some new variables and
several more ways to run tests against expanded targets. Also
added power control section.
(From yocto-docs rev: a0f08466c00ae51a99d790fa6c9dccef2e0f1518)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added Debian 7.5 and 7.6 to the list.
(From yocto-docs rev: 35fd5d5399fe1759158aef19d7b6eb68f2a1af12)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the third set of review comments from Paul Eggleton to
some variables.
(From yocto-docs rev: 2be5bc26a6fda1922ee73a874522180633d33b98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For consistency, I changed the introductory sentence to the
variables that function when inherited.
(From yocto-docs rev: 6ba4fe635c45abf7692f4be0a09ede89a89ec9fa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits were minor with the addition of some descriptions that
had to be fleshed out. All comments from Paul Eggleton.
(From yocto-docs rev: 4ae7c5a5e5aa23307e28de0832d379145c4ef8f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added ASSUME_PROVIDED and SANITY_REQUIRED_UTILITIES variable
place-holders. There is no text there yet but they are there
for placeholders.
(From yocto-docs rev: adfa77dc597303dcff0e95fd4b3ffd5ae2fb08d5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also fixed an error in the compress_doc class.
(From yocto-docs rev: 3c3532ec4f3ab5985ea3c2f3689ab5cdb7e16bad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Improved the formatting of the two examples that show where
sysroots are written.
(From yocto-docs rev: 7807e8a727e1e70c2537ac9ead2ad15305c656ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was a single occurrance of this that used angled brackets
to denote the target (e.g. <target>). I replaced the formatting
with the <replaceable></replaceable> tags for consistency.
(From yocto-docs rev: 4e013136c27d68f89854e78cbf354583d51aa2a8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the manual I was using angled brackets to denote user-supplied
input values. This was confusing so I changed to using the
<replaceable></replaceable> tag pair.
(From yocto-docs rev: dc73a78f11038a1ff04b16867e7513f31f02374b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual I was using angled brackets to denote
user-supplied input. This is confusing so I changed to using
the <replaceable></replaceable> tag set.
(From yocto-docs rev: 79ec3f1b1330539ab2b3bdfb1c94e58c2d0feead)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added the new QA Warnings and Messages chapter to the list.
(From yocto-docs rev: aab515c793107b7c0b3a8a26f522cf26461fd3d4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some minor issues with build-deps and file-rdeps.
(From yocto-docs rev: b4250c9ba7d6a3d30c3dfb94d9e2e2eea6b47764)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Forgot the word "class".
(From yocto-docs rev: e54102d2a5df3f703e4ab23ed9062ef2abf7315b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to change wording to state that the class uses out-of-tree
builds.
(From yocto-docs rev: 2fbaeba33988e14a97d5946f7e714a1bbc5a3ccb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the second round of review edits from Paul Eggleton.
Minor fixes.
(From yocto-docs rev: 2c7c45c8f09b724e92e8b59fe47834226b44b4fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark