Commit Graph

3373 Commits

Author SHA1 Message Date
Scott Rifenbark 0d3e6853a6 ref-manual: Fixed typo in the PACKAGE_EXTRA_ARCHS variable.
(From yocto-docs rev: 85bd37d28b4394d422a70adec9a01a88ba4b4f21)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-08 11:15:12 +00:00
Scott Rifenbark 9104c1c29c dev-manual: Fixed broken link to the allarch class.
(From yocto-docs rev: 3ec771dffdaf7d42b98371516bbb33f915dfe572)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-08 11:15:12 +00:00
Scott Rifenbark 51f6cb03b0 mega-manual.sed: Updated to support the 1.8 release.
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>
2014-11-04 10:28:30 +00:00
Scott Rifenbark 1484e62e5f documentation: Updated the manual revision history tables.
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>
2014-11-04 10:28:30 +00:00
Scott Rifenbark c2d6febad5 poky-ent: Updated variables to support the 1.8 release.
(From yocto-docs rev: 0d7b1b77108e33c17d7169a1134ad176c20cd85f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-04 10:27:13 +00:00
Scott Rifenbark 4faca22b8f ref-manual: Updates to the migrating to YP 1.7 section.
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>
2014-10-28 22:31:18 +00:00
Scott Rifenbark a0aeeff2c6 dev-manual: Updates to "Performing Automated Runtime Testing"
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>
2014-10-28 22:31:18 +00:00
Scott Rifenbark 0761eba74d ref-manual: Added some new test variables:
* TEST_SERIALCONTROL_CMD
 * TEST_SERIALCONTROL_EXTRA_ARGS
 * TEST_POWERCONTROL_CMD
 * TEST_POWERCONTROL_EXTRA_ARGS

(From yocto-docs rev: 25f196cc03178f07201ef183fb309721d412e971)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-28 22:31:17 +00:00
Scott Rifenbark 9908d9ed00 ref-manual: Updated list of supported distros.
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>
2014-10-28 22:31:17 +00:00
Scott Rifenbark ad065f94ac ref-manual: Minor edits to variables.
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>
2014-10-23 15:20:20 +01:00
Scott Rifenbark 78c5c175ae ref-manual: Cleaned up wording in glossary for "inheriting"
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>
2014-10-23 15:20:20 +01:00
Scott Rifenbark 38c853a83d ref-manual: Applied review edits for new classes and variables.
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>
2014-10-23 15:20:19 +01:00
Scott Rifenbark 01f2e75575 ref-manual: Added new uninative class.
(From yocto-docs rev: b227b6a636b0ca194e3f7a4521659304596303e2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21 15:09:17 +01:00
Scott Rifenbark 1ea92a27f6 ref-manual: Added gummiboot class and four supporting variables.
The variables added were:

 * EFI_PROVIDER
 * GUMMIBOOT_CFG
 * GUMMIBOOT_ENTRIES
 * GUMMIBOOT_TIMEOUT

(From yocto-docs rev: 42d548a9c4e6eb8eb67ada258fefb32ba8ba175c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21 15:09:16 +01:00
Scott Rifenbark 82638ca39f ref-manual: Added copyleft_filter class description.
(From yocto-docs rev: 2259f448cf1d102cbf06ad371e90c439812038cb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21 15:09:16 +01:00
Scott Rifenbark 43b8f88c23 ref-manual: Added texinfo class and two new variables.
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>
2014-10-21 15:09:16 +01:00
Scott Rifenbark 369f8d6a7a ref-manual: Added buildstats-summary.bbclass section.
(From yocto-docs rev: 2eb52ec085e1add723548112390d2983b5a6b77e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21 15:09:16 +01:00
Scott Rifenbark 41e7dd22c7 ref-manual: Added BINCONFIG variable and binconfig-disabled class.
(From yocto-docs rev: 16e0176db9927296f721c25792d87b2495b5405b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21 15:09:16 +01:00
Scott Rifenbark 567d9af723 ref-manual: Added ptest-gnome.bbclass section.
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>
2014-10-21 15:09:16 +01:00
Scott Rifenbark 12fb49eb88 ref-manual: Added compress_doc class and DOC_COMPRESS variable.
(From yocto-docs rev: 875b6eb2e01b1bb9b4c8ed3c80553c1d0870cf78)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21 15:09:15 +01:00
Scott Rifenbark f0a2a2f445 ref-manual: Updated the populate_sdk_* class
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark a424bebb2e profile-manual: Scrubbed and fixed user-input formatting.
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark d6e89e7122 kernel-dev: Scrubbed and fixed all user-supplied input formatting.
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark 5f613896ee adt-manual: Scrubbed and fixed user-supplied input formatting.
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark 2eaf7e6e75 ref-manual: Scrubbed for variable (user) input.
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark b96378eb6b ref-manual: Updated the introductory section list manual overview.
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>
2014-10-18 16:15:29 +02:00
Scott Rifenbark 31d0bb239f ref-manual: Minor edits for review on new QA checks.
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>
2014-10-18 16:15:29 +02:00
Scott Rifenbark e5255cce86 ref-manual: Added [build-deps] QA error message.
(From yocto-docs rev: 1883450fe2ca823dc258283a76012bf75b38615b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:29 +02:00
Scott Rifenbark d5d81afd1c ref-manual: Added [file->rdeps] QA error message.
(From yocto-docs rev: d0546876a775c3d632a4a270aaaa8790a1e0535b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:29 +02:00
Scott Rifenbark 41173c8d7d ref-manual: Added new build-deps QA check to insane.bbclass.
(From yocto-docs rev: fe8862304f1f78bda924dc5c46cb22f876373875)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:29 +02:00
Scott Rifenbark 3305c26f06 ref-manual: Added file-redeps QA check to the insane.bbclass.
(From yocto-docs rev: 85a0cec2a36889485f1bd010a85e0115303409a0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:29 +02:00
Scott Rifenbark 8998871ba5 ref-manual: Added new do_package_qa task entry to tasks chapter.
(From yocto-docs rev: 7b95f578061777bc54c9b3d622db53b4745fd003)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:29 +02:00
Scott Rifenbark 3c29495e90 ref-manual: Another change to the autotools class.
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>
2014-10-18 16:15:28 +02:00
Scott Rifenbark 360ad123c4 ref-manual: Updated the autotools class.
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>
2014-10-18 16:15:28 +02:00
Scott Rifenbark e9ecf3fc24 dev-manual, ref-manual: Updated 1.7 migration section with review comments
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>
2014-10-18 16:15:28 +02:00
Scott Rifenbark 8eb706a41b ref-manual, dev-manual: Applied migration review edits.
Applied the full set of first draft revision edits for the
new migration section for 1.7.  Comments from Paul Eggleton.

(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:28 +02:00
Scott Rifenbark 323929d1ee ref-manual, mega-manual: Updated build history figure
The figure needed to be updated to reflect that build-id.txt
is now part of the tree and not build-id.

The publication scheme dictates that figures are kept in
individual manuals and in the mega-manual figures directory.

(From yocto-docs rev: 0711a3e41c42eb058db25ff2ea7f1c0982e06963)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:27 +02:00
Scott Rifenbark d8e41e8026 ref-manual: Added new migration section for the 1.7 release.
(From yocto-docs rev: 5b06b29f7f9e53db7b885795c2e11e1eccfc98df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:27 +02:00
Scott Rifenbark a51b755178 ref-manual: Updated the build history section for build-id.txt
This file is what is written now rather than build-id.  I changed
the file name and noted that it also contains the full build
header information as written out by BitBake during the build.

(From yocto-docs rev: 7e55b4b5f9e27f6ac5d8f1eab4923bf1b8a712c6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:27 +02:00
Scott Rifenbark ba0483c9ed dev-manual: Updated the list of linux-yocto kernels
I removed the linux-yocto 3.4 kernel from the list in the
section describing which kernels we support.  Also, added
the 3.17 linux-yocto kernel to the list.

(From yocto-docs rev: 41f57a9abe1201ed2fb657f8441c97f86f75200a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:27 +02:00
Scott Rifenbark 3d1820bbb3 ref-manual: Added cross-reference.
(From yocto-docs rev: f64cc93d364a04c51f2c685fffad7a124349474a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:26 +02:00
Scott Rifenbark 4b03b71a52 ref-manual: Updated the module_autoload variable.
This variable has been replaced by the KERNEL_MODULE_AUTOLOAD
variable.  I updated the description to note that and to provide
a cross-reference to the new variable.

(From yocto-docs rev: 8b2f464f7d100db1c585ccc62d7cab89f7f7b164)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:26 +02:00
Scott Rifenbark c2e2eb7667 ref-manual: Added new KERNEL_MODULE_AUTOLOAD variable.
Added this description to the variables glossary.

(From yocto-docs rev: 3da322f92d5028e96422e0c1f5df78b285f2355e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:26 +02:00
Scott Rifenbark d6c0a7d540 ref-manual: Added new KERNEL_MODULE_PROBECONF variable
Added this new variable to the variable glossary.

(From yocto-docs rev: d2d75631777f6cef3472bde428ed65419c99457e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:26 +02:00
Scott Rifenbark 55169b9141 ref-manual: Updated module_conf variable
This description was a bit confusing with the way the general
syntax was described so I re-wrote it a bit.  Also, added the
requirement that if you use module_conf for a given <modname>,
then you must also include the <modname> as part of the new
KERNEL_MODULE_PROBECONF variable.

(From yocto-docs rev: 15b7819a0d9946ad6565576a6f28897e2dd724f9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18 16:15:26 +02:00
Scott Rifenbark 3e991ee685 ref-manual, template: Permalinks for QA errors and warnings
Updated the ref-qa-checks.xml chapter so that each QA warning
or error message would generate a permalink that is suitable
for searching from the poky codebase.  To implement this, I
had to embed an id marker in the <para> tag that precedes each
<code></code> tag pair.  The 'xxx' string of the id is the leaf
portion of the permalink.

This creates the following tag construct:

    <para id='xxx'>
        <code>
            some-warning-or-error-message
        </code>
    </para>

The permalink is generated with the help of the new
qa-code-permalinks.xsl file, which triggers on the
<para><code></code></para> construct.  This new file resides
in documentation/template.

Right now, this construct
is unique to the ref-manual's chapter on the QA error and warnings
chapter only.  However, if for some reason that construct is
used in any other part of the ref-manual, a generically numbered
permalink would also be generated.

The ref-manual-customization.xsl file was also altered to include
the new documentation/template/qa-code-permalinks.xsl file.

Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-10 16:44:34 +01:00
Scott Rifenbark 6f32f3c757 ref-manual: Fixed grammar use in "Image Features" list.
(From yocto-docs rev: eb4ff8e1345987391e735f088d685ec70e641ed1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-10 16:44:33 +01:00
Scott Rifenbark 6c3d1192c7 documentation: Updated release date for manual rev tables.
Added "October 2014" to table for all manuals that have the
table.

(From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-03 14:41:30 +01:00
Scott Rifenbark e90f4a1360 ref-manual: Minor edits to "Image Features" section.
Reversed order of the list presentation and re-worded the static
library sentence.

(From yocto-docs rev: 5c32730550629527f6ceb2140df31a097f7a6081)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-03 14:41:29 +01:00
Scott Rifenbark 6d843e6336 ref-manual: Edits to the "Image Features" section layout
I updated the section to have two lists of features.  One list
is for features that work only when you inherit the core-image
class.  The other list is for features that are available for
all images regargless of inheriting this class.

(From yocto-docs rev: 9d1bcab2a9264e64db2dec66247aaf55493ae362)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30 21:37:43 +01:00