Commit Graph

52 Commits

Author SHA1 Message Date
Scott Rifenbark 28144187da ref-manual: Added the version-going-backwards test to insane
Added this new test to the insane.bbclass section.  Also put
in a reference in the migration section back to the new
entry.

(From yocto-docs rev: 32e25547b439030b93d9bc72bdce916eded518b4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:54 +01:00
Paul Eggleton 89d3e75087 ref-manual: Added some more undocumented classes
Paul sent a few more for the list.

(From yocto-docs rev: ea4dd51b4e5fdedf767d8318507551f00c6d46d3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:53 +01:00
Scott Rifenbark eb36aaa07f ref-manual, dev-manual: Edits to running automated tests section.
Applied a second round of review edits from Paul Eggleton
for the new "Performing Automated Runtime Testing" section.
I did some reorganization and some minor wording changes.

(From yocto-docs rev: fa8f8e5f0f6c1377a4fcafcd3d933af15ac01ff3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:53 +01:00
Scott Rifenbark 18d6adb73e ref-manual: Updated the autotools.bbclass section
Re-wrote the sentence refering to the make variable DESTDIR.

(From yocto-docs rev: 392e6e17c4f65fd038ec9bb73823837803543baf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:52 +01:00
Scott Rifenbark e44538f4e4 ref-manual, dev-manual: Applied review comments for test section
The section and variables for performing automated runtime tests
on images was reviewed by Paul Eggleton.  The suggested changes
were made.

(From yocto-docs rev: c2f84ea3c162892e4da3df30fb833f88bab3d3cc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:51 +01:00
Scott Rifenbark 06cddebe6d ref-manual: Added a new entry for the testimage.bbclass.
(From yocto-docs rev: 05db9912f837d79c7da3411586248dcc78172985)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:49 +01:00
Scott Rifenbark 0c0ac7dd3a ref-manual: Updates to insane.bbclass and two new variables added.
* Updated the insane.bbclass section to move the note at the
  end about using ERROR_QA and WARN_QA to control how the
  checks are reported to the front of the section.

* Added new variable entries for WARN_QA and ERROR_QA.

(From yocto-docs rev: 6f220d1ba3d44a1bba2f1ac882cdf6b601ddc5bb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:19:00 +01:00
Scott Rifenbark 35655863ca ref-manual: Review comments added, new variables added
* Updated some links in the insane.bbclass sectioni so they
  now point to some new variables.

* Added glossary descriptions for PKGD, PKGDEST, and
  INCOMPATIBLE_LICENSE.

* Added a paragraph to the LICENSE variable to describe
  situations where the output might have components whose
  licensing is from two different licenses (licensing on
  a per-package basis).

(From yocto-docs rev: b8dd3b3d5cb912ed7c5d3c9b6c01d93347e95b84)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:19:00 +01:00
Scott Rifenbark b7c167af1c ref-manual: Small wording change to installed-vs-shipped test.
(From yocto-docs rev: 40257d5011dbc22d1d40e13f8ae2229b8e5de50c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:19:00 +01:00
Scott Rifenbark a89b418d3f ref-manual: Added more QA checks to the insane.bbclass.
Fixes [YOCTO #4788]

Added a bunch of new checks to the list of checks in this
class.  I also recast the section head to just have the
class file as the section heading.  This resulted in a link
that needed changed.

(From yocto-docs rev: 4a4df80c0b6012ad09ea526d2893e729aa06965b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:59 +01:00
Scott Rifenbark 61ce3fd240 ref-manual: Added BINCONFIG_GLOB variable and updated binconfig.bbclass
New variable.

Changed the class section to have a reference-like section title.
Added a link back to the GLOB variable.

(From yocto-docs rev: 42dbafc1b64d8572930501f25a0470038721524f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:55 +01:00
Scott Rifenbark e5b5b5a9f4 ref-manual: Updated the update-alternatives class
Added some links to four variables that are now documented in the
glossary.

(From yocto-docs rev: de7574be7c805173318b77d39c7b540bff4108df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:54 +01:00
Scott Rifenbark 203b2f7615 ref-manual: Edits to the binconfig.bbclass section.
(From yocto-docs rev: 7b442239b8dc083c0191e863cb959fb978ea6345)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:54 +01:00
Scott Rifenbark d22a3907f1 ref-manual: Edits to OE_BINCONFIG_EXTRA_MANGLE and binconfig.bbclass
(From yocto-docs rev: d732e0a32d1bc5dccd9bf6522bb9852df3b63ebd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:53 +01:00
Scott Rifenbark d066247ade ref-manual: Changes to the externalsrc.bbclass reference section.
Updated this to not contain usage information, which has been
moved to the dev-manual.  I diff'ed out this commit and there
are some changes that resulted from accidental deletion and
restoration of a large amount of text.

(From yocto-docs rev: fdefcfd77811d2cfe65d51b70f3bc69018f3de81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:50 +01:00
Scott Rifenbark 53ad9b2f01 ref-manual: Edits to teh "Archiving Sources - archive*.bbclass" section.
Some formatting to fix up Kevin's patch.  One thing important was
that the <ulink> line cannot span multiple lines.  I fixed this.
When they span multiple lines, the sed script used to convert the
links for the mega-manual breaks.

(From yocto-docs rev: e31012878c709eccae94734f7933559cb1187c47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:13 +01:00
Kevin Strasser 82269903d3 ref-manual: New class added for archive*.bbclass.
Patch from Kevin that adds a new class.  Note that the
patch removed the existing src_distribute_local.bbclass
class.

(From yocto-docs rev: 4ce602093bc9ddfcbcd9392bcc8fd6187885bdf1)

Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:13 +01:00
Scott Rifenbark 068085f790 ref-manual: Review comments applied for patch session
Paul Eggleton provided quite a series of patches that I previously
applied.  These changes represent the edits from an interactive
review he conducted with me.  The series of changes represents
his review for the entire set of changes in the original patch
series.

(From yocto-docs rev: e26f615a01de2b101e97eb6fd7175b813f74295e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:17 +01:00
Scott Rifenbark 424611ace8 bsp-guide, ref-manual: Spell checks on some chapters.
Performed some spelling checks against the files associated
with a large number of patches sent by Paul Eggleton.

(From yocto-docs rev: 8b16924aa1da161271cbfce5410344d94c840fa6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:17 +01:00
Scott Rifenbark b3a49b8203 ref-manual, dev-manual: Added links to the RPROVIDES variable.
(From yocto-docs rev: 96f9e09d977b4b81b956f4742c47a9393f30eae4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:17 +01:00
Scott Rifenbark db4f0eab99 ref-manual: Added a cross-reference link to the RSUGGESTS variable.
(From yocto-docs rev: 6a9a894bdc98acf6d32466927ebc3f1db69aacb6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:17 +01:00
Scott Rifenbark a8f1e2d6df ref-manual: Fixed section title capitalization.
(From yocto-docs rev: cbbb76a62be7acce5b62e449e09c08b4a18c11d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:16 +01:00
Scott Rifenbark 424b0410b4 ref-manual: Added a cross-link to the INSANE_SKIP variable.
(From yocto-docs rev: 73561644c4fa0aae4217862e8d15a0cb2d874dd1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:16 +01:00
Paul Eggleton 47cb48159f ref-manual/ref-classes: minor typo fixes and clarifications
Removed a redundant use of "and" and broke the long sentence into
two.

(From yocto-docs rev: d6087ffaf36a3e3f16a7910c2b065bebaaf20a23)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:15 +01:00
Paul Eggleton 411022f8dd ref-manual/ref-classes: add note to insane.bbclass section on INSANE_SKIP
Performed a few edits to clean up some sentences.  Broke one long
sentence up into two.

(From yocto-docs rev: 7641113906e062b751abb5366827fe302ec4a2b9)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:14 +01:00
Paul Eggleton 0ffd01f835 ref-manual/ref-classes: add missing QA checks
Added proper text formatting and cross-reference links to the
variables that exist in the reference glossary.  Did a bit of
writing to shorten some long sentences and perform general
clean up.

Add the following missing QA checks to the section on insane.bbclass:

* textrel
* pkgvarcheck
* xorg-driver-abi
* libexec
* staticdev

(From yocto-docs rev: 2857cc20b3b136b17d1d2892e046b2ae7f4b699d)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:14 +01:00
Paul Eggleton 35c4e1512a ref-manual: add more undocumented classes
(From yocto-docs rev: ac3cfb6ad67fc6963ebe50fa4451297772a1c2e7)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:13 +01:00
Paul Eggleton c3ecfdb707 ref-manual: add documentation for rm_work.bbclass
I rewrote the class description to conform to the existing
manual style.  Mainly making voice active and breaking up
long sentenced.

(From yocto-docs rev: e715167e280eb647be52c142f733942dab3f4dfb)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13 23:57:13 +01:00
Scott Rifenbark 9a98f403bd ref-manual, dev-manual: Review comments applied to package repository
Changes are the review comments from Paul Eggleton regarding
setting up the optional package repository on the host that
can be used by Smart.  These changes reflect the fact that
the task is not package-type dependent or host web server
dependent.

(From yocto-docs rev: 779989878bcc9501ddc4570519d93325442a8493)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:45 +01:00
Scott Rifenbark 0e0ee96186 dev-manual, ref-manual: Changes to support runtime management
Created the first draft of the new "Setting Up Runtime
Package Management" section in the dev-manual's common
tasks chapter.

Updated the "Packaging - package*.bbclass" section in the
ref-manual to mention this capability and point off to the
dev-manual's new section.

(From yocto-docs rev: d91c8530dba20839f36c5e247cc447adbedac7fd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:45 +01:00
Scott Rifenbark 4ce46de598 ref-manual: Added Smart-enabled package feed info to section.
There are steps the user can take to create a host-resident
package feed (repository) whose front-end is Smart.
The setup allows the user to install packages from the host
feed during runtime on the target.  The changes I made now
include that fact.

I also reformatted into a list some of the RPM limitations
and benefits as they now numbered such that I could list
them out as such.

(From yocto-docs rev: bb733ec59c9275071ff5ff017adc52073d4dcef8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:44 +01:00
Scott Rifenbark 1977dcf3f8 ref-manual: Added cross-reference link to term "Metadata".
(From yocto-docs rev: a182cae60ccddfc881eb5c835dbb64db84f6d733)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:44 +01:00
Scott Rifenbark 072b38a5c2 ref-manual: Added new variable entry for BULIDDIR.
Ross Burton suggested this might be good to have so I added
it.  The changes include the entry itself and a link to it
from the beginning of the "Classes" chapter where it is
talked about.

Reported-by: Ross Burton <ross.burton@intel.com>
(From yocto-docs rev: 5b0263fa5e01706ccb815db51b8f1b7f86275721)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:36 +01:00
Scott Rifenbark 73d463c51a ref-manual: Some typos corrected via spell check.
(From yocto-docs rev: 39fa2adeef3c7a27d6f166139b72fa9765cc0486)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:36 +01:00
Scott Rifenbark c209bdccb0 ref-manual: Added a note about what the chapter covers.
(From yocto-docs rev: 5e9e57bf987be2d64ae7ac5137304aa9545e329d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:36 +01:00
Scott Rifenbark 2cc1a1cd0c ref-manual: Minor edits to "Using External Source - externalsrc.bbclass".
(From yocto-docs rev: 35a5e53ad67b1458c29efa516c976fbd57c6b549)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:35 +01:00
Scott Rifenbark eb4d51a92a ref-manual: Added some links into the glossary.
(From yocto-docs rev: cfbbba163e07ac66e5957a9791e53810d7c8ce5f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:35 +01:00
Scott Rifenbark c7ab29d71a ref-manual: Grammar and punctuation fixes.
(From yocto-docs rev: 6352ea714b653f2a6d4e189eefb6376161bc1de8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:35 +01:00
Scott Rifenbark cb234f5f90 ref-manual: Created a list as needed.
(From yocto-docs rev: 81ea1833a7c5b4080b3947422f42b13d59770085)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:35 +01:00
Scott Rifenbark 28ae8f90b3 ref-manual: Minor edits to "Packaging - package*.bbclass".
(From yocto-docs rev: b6d4fe49442039cacc07224c68d4df0e6996ff43)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:13:35 +01:00
Scott Rifenbark 17bad274c3 ref-manual: Minor edits to "Package Groups - packagegroup.bbclass".
(From yocto-docs rev: a33e10a9005c222bd91e22b0e6e5fc321e50e651)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:58 +01:00
Scott Rifenbark 1b973beea4 ref-manual: Substituted in a list as needed.
(From yocto-docs rev: 45568c5a2eac5341327a61011365355901624772)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:58 +01:00
Scott Rifenbark 18437d1857 ref-manual: Created a list where needed.
(From yocto-docs rev: 0a41b4de0a2991b983356d6458d8f5f797323f6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:58 +01:00
Scott Rifenbark b92e6c294f ref-manual: Got rid of some ugly sentences.
(From yocto-docs rev: a63ae4ec495be7cbd630f60feb9aaf5ea383dca4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:58 +01:00
Scott Rifenbark b5792eca78 ref-manual: Removed non-word "subdirs".
(From yocto-docs rev: 74fb953d30a6e4dee9e3a97676499cea379bb6b5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:58 +01:00
Scott Rifenbark 5f480dfa62 ref-manual: Applied better wording.
(From yocto-docs rev: f6cc486d1b83cd109c98abe018509f1b14b7f03f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:57 +01:00
Scott Rifenbark 658227f2e3 ref-manual: Minor edits to "Autotooled Packages - autotools.bbclass".
(From yocto-docs rev: f86dbc7f14bb8679f4b0b760217380d5ca41f9bf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:57 +01:00
Scott Rifenbark 66e07441b8 ref-manual: Formatting fix for BUILDDIR variable.
(From yocto-docs rev: cd963d208ef48cdb652382e69ceec873b15c5102)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:57 +01:00
Scott Rifenbark e55f7721c9 ref-manual: Added cross-reference to "Metadata" term.
(From yocto-docs rev: 3d0d22aba6e42a39b80f15edeb06e88d6dd835a2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:57 +01:00
Scott Rifenbark 031305f847 ref-manual: Edits to make section heads consistent capitalization
Various section heading titles were not using capital letters
for primary words.  Fixed this up.

(From yocto-docs rev: da15d2ac3d043a0296a51d1a9fac69e7b4229f75)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22 17:08:43 +00:00