Commit Graph

1934 Commits

Author SHA1 Message Date
Scott Rifenbark
bbe3bf4bfe ref-manual: Grammar correction
I left out the word "not" in a key sentence in the new
"Checking on the Upgrade Status of a Recipe" section.

Little words can make big differences.

(From yocto-docs rev: 46a524a0d6c9e2ed6428039a4454e384a6ef648d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
99f9a53b6b ref-manual: Updates to check-recipe-upgrade devtool command
I updated the section to include more detail on what the user
sees in the returned table.

(From yocto-docs rev: 671279548dde7f356888ba1ad1551b8bb1f70a65)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
bbdf0453d0 ref-manual: do_checkpkg - added link to checking upgrade status
I show the "devtool check-upgrade-status" command as part of
the "do_checkpkg" task section.  I added a cross-reference
link to the "Checking on the Upgrade Status of a Recipe"
section in the ref-manual.

(From yocto-docs rev: 034054f431cc9f0e61c8e156eed66bdf6e1198a1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
e6b1e54d85 ref-manual: New section "Checking Upgrade Status of a Recipe"
I added a new section showcasing the "devtool check-upgrade-status"
command.

Also, added a note in the "Upgrading a Recipe" section" to tell
the reader they might want to check on a recipe's upgrade
status before upgrading a recipe.

(From yocto-docs rev: 974f63fe8836fccd51f12b511c23644235cbd4b4)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
50d2fb44a5 ref-manual: Udated devtool help output examples.
Specifically missing was the "devtool check-upgrade-status"
command.

(From yocto-docs rev: beaa40e8d1037f237ab588ec6ce256b8c3a18543)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
890a993be1 ref-manual: Removed "distutils-tools" class.
This class was removed for 2.7 and I took the reference section
out of the class area.

(From yocto-docs rev: daf786bebb0286d2ced46c97957d80a94c921c56)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
a4782409c4 ref-manual: Removed bugzilla.bbclass
The migration section noted this class as becoming obsolete.
I removed it from the class reference section.

(From yocto-docs rev: 63128888242493fb5671f11a2e5e470f2da6b22a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
f21fc9d1be dev-manual, ref-manual: removed "distrodata" class
Ousted these since it was noted in the migration section that
the class had been removed.  Modified all references to the
removed class as needed.

(From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
d4fc8cf7ae ref-manual: Updated "do_fetch" to have a link to "Fetchers"
Fixes [YOCTO #10098]

This task needed to cross-reference the "Fetchers" section,
which is in the BitBake User Manual.

(From yocto-docs rev: c8862f4c8cc43777acead0e93fc728f2e8be4641)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Adrian Bunk
39f30789e2 ref-manual: Remove irda feature
IrDA support was removed in upstream kernel 4.17,
and irda-utils as well as the feature are now also removed.

(From yocto-docs rev: 5650b3c733310b4d478440449d427de417946c81)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07 13:57:41 +01:00
Scott Rifenbark
a015ed7704 ref-manual: Added "npm" information to the SRC_URI variable.
(From yocto-docs rev: 644cf94333ef289e9d0719f46b76f712f4807573)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-15 21:54:15 +01:00
Scott Rifenbark
10edc0b04e ref-manual: Updated PREFERRED_VERSION variable to use 5.0
I changed the PREFERRED_VERSION_linux-yocto example to use
the 5.0 linux-yocto kernel rather than the 4.12 version.

(From yocto-docs rev: 334554dd87f5372066d55246384ed5205aaf1f86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12 09:14:03 +01:00
Scott Rifenbark
59f95aaae4 documentation: Cleaned up "plug-in"/"plugin" terminology.
The YP manual set was using the plugin term inconsistently.
It was appearing as "plugin" as well as "plug-in".  The
plugins in the project are all named without a hyphen.
The term itself is either/or according to Google.  I have
changed all references to plugin so that they do not use
a hyphen.

(From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:42 +01:00
Scott Rifenbark
bfe52a3d6c ref-manual: Updated the "Container Layer" term.
I removed the incorrect "meta-intel" layer for the example
and replaced it with the better "meta-openembedded" layer.

Reported by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: eed35c97aa53efdcdb9a270555774a7c3a0e3b69)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
3693f075c4 documentation: Prepared for 2.8 release
poky.ent - variables all set up for 2.8
mega-manual.sed - "2.7" replaced with "2.8"
<folder>.xml - manual revision history tables updated.

(From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
aa90b8ca24 ref-manual: Review comments applied to 2.7 migration section.
(From yocto-docs rev: 81ced4c68631d4d63efec206e5453b00d8fcc786)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
69684c489e ref-manual: Added Fedora 29 to the supported distros list.
(From yocto-docs rev: 196bc35669e81b269d4576f552bdecc191bbc80a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
d38a253147 ref-manual: Added "License Value Corrections to migration.
(From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
24c80ee695 ref-manual: Added Eclipse removal for migration section.
(From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
932b8ae307 ref-manual: Inserted Migration 2.7 section.
(From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
75cf92d446 ref-manual: Removed all references to Eclipse
Links updated as needed.

(From yocto-docs rev: acd5a75314b023f613be24b7512f991f8455e325)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:41 +01:00
Scott Rifenbark
c18fe9eb64 Documentation: Removed customization.xsl files for Eclipse
The help files for YP manuals used in the Eclipse application
are no longer supported.  I removed the individual
*-customization.xsl files for the individual YP manuals.

(From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07 10:23:40 +01:00
Scott Rifenbark
5555841e5e ref-manual: Updated BB_GENERATE_MIRROR_TARBALLS
Updated the description to tell the user they can safely
clean up the DL_DIR after creating tarballs of the source
files from downloaded repos.

(From yocto-docs rev: 6aff69632ea3102b6389ea510e1e3fa5bf1c2123)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09 22:16:06 +01:00
Scott Rifenbark
35742c10f5 ref-manual: Removed DISK_DESCRIPTION variable from glossary
(From yocto-docs rev: 0bc99a673376e70279a353f654287068c59a0b03)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-26 15:38:56 +00:00
Filip Jareš
28f9cf565a ref-manual: Fixed SRC_URI cut-and-paste error.
The update fixes a copy-paste-and-forget-to-update-everything error
in the documentation of the `SRC_URI` entry in the Reference Manual.
The `maxdate` paragraph just repeated what is there for the
neighboring `mindate` paragraph which was incorrect.

(From yocto-docs rev: bbeb096222d42a31adcb358a85f8fe6c4120416a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
e63d516db3 YP Documentation: Updated host package lists
Changes to the lists resulted in the testing and graphics &
Eclipse Plug-in lists going away.  Also, I added several packages
based on some testing requirements to the "Essentials" list.

(From yocto-docs rev: cbc9a595bef3dd80f5eef1376e466627248f9fda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
5c2dca7e75 ref-manual: Added INIHIBIT_SYSROOT_STRIP variable desc.
(From yocto-docs rev: 867c5affcecff77ec4b36f026baba80a6bf4fe62)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
8c7ec72e6d ref-manual, poky.ent: Updated essential host packages
Fixes [YOCTO #13196]

The set of host packages for the testing has been merged into
the essential set of packages for all supported distros.  I
updated the variables defined in "poky.ent" so that these
packages are now part of the essentials.  I also removed the
section on the required packages for testing.

(From yocto-docs rev: 9b19661d21a14966eac162ee063fca46d6403323)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Scott Rifenbark
5fa73c1392 ref-manual: Removed DISTRO_FEATURES_LIBC variable
Took this out of the glossary.  After eglibc was merged
into glibc, Kconfig support was also dropped so
these libc features therefore are not effective anymore
and can be removed.

(From yocto-docs rev: cfdd02864f004fc48b0353ec0f007ca24b06d29e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19 23:54:02 +00:00
Daniel Ammann
b421a21f2f ref-manual: Typo found and fixed.
(From yocto-docs rev: 8a64478540dcaad5e79d5ef494f9086a3c8a50a1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
0867bde9a2 ref-manual: Review edits to FILESOVERRIDES variable.
Fixes [YOCTO #13112]

Added a reference in the FILESOVERRIDES variable description
to the FILESPATH description to see an example of how automatic
overrides work.

(From yocto-docs rev: e78fc3468de3d9b9935f0e4f4aa4117b6805e631)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25 10:44:07 +00:00
Scott Rifenbark
554379870f ref-manual: Updates to FILESPATH and FILESOVERRIDES.
Fixes [YOCTO #13112]

Did some paragraph re-ordering based on reviewer feedback.
Also, added a bit in the FILESOVERRIDES variable description
about out it uses overrides to help with automatic overriding
of the FILESPATH variable.  Added some better links into the
BitBake User Manual as well.

(From yocto-docs rev: 6ad5c6f030501cda9bc8ea648d9d7c0e991f55cf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-16 08:19:55 +00:00
Scott Rifenbark
d36b193caa ref-manual: Fixed literal formatting in INC_PR variable.
No indentation was being used for the example.

(From yocto-docs rev: e5d13181546d19772fede972b20518103d897eaa)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:01 +00:00
Joshua Watt
4d7db0fb1c ref-manual: Update default value for PACKAGE_DEBUG_SPLIT_STYLE
The new default is "debug-with-srcpkg"

(From yocto-docs rev: b427e7c2d9f6efca7e0867cc8e508d4e941c5a09)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:00 +00:00
Scott Rifenbark
d31fcfa652 ref-manual: Updated list of supported distros.
(From yocto-docs rev: 95eadbcc69b83ef92f28098058d62c596d4936cc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12 21:49:00 +00:00
Peter Kjellerstedt
676705765a ref-manual: Update to SDK_VERSION variable.
Updated the definition to match that of poky.conf.

(From yocto-docs rev: 09c73c227c6949ed3f1287ce063aa96967ed2fda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-21 16:11:43 +00:00
Scott Rifenbark
2480e01188 ref-manual: Updates to FILESPATH and IMAGE_FSTYPES variables.
Fixes [YOCTO #13112]
Fixes [YOCTO #13115]

* FILESPATH: Added a detailed example of how to use the variable
  to set machine-specific configurations.  Also, noted the default
  behavior of using FILESOVERRIDES to automatically extend
  FILESPATH. Did some rewriting as well.

* IMAGE_FSTYPES: Updated the note to not be exclusive to "live"
  images.  The behavior applies to many images.

(From yocto-docs rev: 46e3f2545c45ba5391603f9ffa1c87896d472df6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-16 15:35:57 +00:00
Scott Rifenbark
2c0db14f94 ref-manual, overview-manual: Fixed BitBake User Manual links
Some occurrences of links to the BitBake User Manual were using
a target (i.e. &YOCTO_DOCS_BB_URL;#bitbake-user-manual).  Using
this form causes the mega-manual.sed file to not process the link
correctly for the mega-manual.  These are subtle errors and have
probably existed for some time.  I removed the target ID to fix
the problem.

(From yocto-docs rev: 701f61fd80e5103ee02efbe5eed9a8607ac9a336)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27 22:53:11 +00:00
Peter Kjellerstedt
1e534573c7 ref-manual: Document the fifth argument to PACKAGECONFIG
(From yocto-docs rev: adb17e3172c829de77d2664c91f7cf4b22c9e5f0)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Peter Kjellerstedt
989577c4ad ref-manual: Add missing whitespace around "=" in a few code examples.
(From yocto-docs rev: 0d22771c64d082bf86f5efd85ac9aaeb1c7f3093)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Scott Rifenbark
dfe7b95ea4 documentation: Preparing for 2.7 release.
Updated poky.ent to have variables for 2.7.
Updated mega-manual.sed file to use "2.7" string.
Updated all <manual>.xml Manual History Tables to use "TBD"

(From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Scott Rifenbark
d29f4dcc45 ref-manual: Updates to CMake and cmake.bbclass.
I cleaned up the terminology used for the CMake build system.
I provided some meaningful links to a good overview page for CMake.
I also built in some cross-referencing as needed.

(From yocto-docs rev: 7c38add39b97a7a8786a1be53f9ff549e4727fad)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15 11:48:59 +00:00
Armin Kuster
6b84ac7883 ref-manual: Updated list of supported Linux Distros:
Updates for the "thud" release.

(From yocto-docs rev: ccd2d2c7b062627a3fd1961ab23ee6fff714428a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
10d53356a2 ref-manual: Added a note saying WSL is not supported.
Windows Subsystem for Linux (WSL) is not supported with the
Yocto Project.

(From yocto-docs rev: 0898d7fb7166da91598854f385cd574004098ac3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Ming Liu
236e2c80de ref-manual: Updated image_types.bbclass description.
The "image_types" class is now inherited mandatorily in
image.bbclass through the variable IMGCLASSES.  Users do not
have to inherit it in their customized image type bbclass.
They also do not have to put it in IMAGE_CLASSES.

(From yocto-docs rev: bd391092b216e39dad317dc1aae5c715371766ef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
4adb1e29a1 ref-manual: Added description for devupstream.bbclass
New section added.

Fixes [YOCTO #12732]

(From yocto-docs rev: 3d4a1fef8e1809cd7f1dece55790b6ee12dc60b3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
69f269e090 ref-manual: Added cross-references to "Post-Installation Scripts"
Two areas in the migration chapter discuss the post-installation
behavior when you defer the scripts to after boot.  I added a
couple references to each of those migration note sections that
go into the dev-manual's section.

(From yocto-docs rev: eeb09b5fa208499f37be4e5aafcf55db82715fd1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
108fe4b941 ref-manual: Updated "Packaging Changes" section for 2.6 migration.
Changed reference to "python-modules" to "python-modules /
python3-modules".

(From yocto-docs rev: 49d66f928366dda19b6afd1e9ac6431f0f66ab21)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
028deee71f ref-manual: Applied review edits to the 2.6 migration section.
Minor fixes here and there.

(From yocto-docs rev: 740b4392bd98a12f188b79ae3ecdc7c3031f9f7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:52 +00:00
Scott Rifenbark
83b605ccef ref-manual: New 2.6 Migration section complete.
(From yocto-docs rev: 6597ea2d706e3975ff0ffae15cf748ffd7aaed8b)

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