Commit Graph

148 Commits

Author SHA1 Message Date
Tim Orling
07aaa69d57 ref-manual: add install-buildtools and -extended
Add instructions to use 'install-buildtools' and
'buildtools-extended-tarball'.

Add gcc 5.0 requirement and call out how to
use above to prepare host development system.

(From yocto-docs rev: c6dbd9bf6860ffea1bc025907343373439d91737)

Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:25 +01:00
rpjday@crashcourse.ca
0096b10efe correct mention of "postinst_intercept delay_to_first_boot"
Migration to YP 2.5 contains incorrect description of routine for
delaying to first boot.

(From yocto-docs rev: 08f71ec137822c0c19b56956d7045dfb73a544d7)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-04-06 14:40:24 +01:00
Peter Kjellerstedt
91241f2b12 ref-manual: Add missing/remove extraneous quotes
(From yocto-docs rev: 542e362bf06c2d71ee6e30f5728ad5476f035c6e)

Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-11 14:41:44 +00:00
Scott Rifenbark
9383489102 ref-manual: Removed blank lines from 3.0 migratrion section.
(From yocto-docs rev: a3c4701e0b6fc90aaa7138c1fd772e0d8ad7e3a6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10 14:06:31 +00:00
Scott Rifenbark
370e4b223d ref-manual: Completed the 3.0 migration section.
(From yocto-docs rev: 1f996ce595b91e2dba55bdeeb2a558eb8a16c195)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10 14:06:31 +00:00
Scott Rifenbark
b70a4d8d5d ref-manual: Removed deprecated link to ref-classes-bluetooth
This was in a moving to YP version 1.8 migration section.

(From yocto-docs rev: b87f0882c39524747004fafc4d1caf58b3344c3a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:53 +01:00
Scott Rifenbark
c1fc3ed407 ref-manual: 2nd pass 3.0 migration
Turned "2.8" into "3.0".  Nobody told me about skipping
2.8 and 2.9.

(From yocto-docs rev: 13819f0651c48adae9d1a8d6d19341ba5ee44978)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:52 +01:00
Scott Rifenbark
269f3c8873 ref-manual: First pass of 2.8 migration changes (WIP)
(From yocto-docs rev: 2c0f6cd921132caa4f49c34ac592db68be27761a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23 17:15:52 +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
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
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
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
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
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
Scott Rifenbark
184b441580 ref-manual: Added new python3 profile-optimization migration topic
(From yocto-docs rev: 2d0960d9282ffcb843ed9956a0e49183b22f11f2)

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
40433a0229 ref-manual: Updated postinstall migration note.
(From yocto-docs rev: fa6582df36d770e7207e4c5201dafe0e64f46a76)

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
506bbde783 ref-manual: Updates to the 2.6 migration section.
This is the completed first draft.

(From yocto-docs rev: 45d39b7655ea5b515c8dda91249a84ee19387099)

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
c029a905c8 ref-manual: Added several new sections to the 2.6 migration section.
(From yocto-docs rev: 54703fbde3f7808b9257da883fe8e4769a65fc44)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
ba78d21173 ref-manual: Updated migration section for 2.6
Made two minor corrections from reviewer feedback.

(From yocto-docs rev: 765e44127f52e1d9d4d1c365b0574ca73364add2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
12eee34540 ref-manual: Updated 2.6 migration topic "_remove"
Provided more explanation and also a link into the BB manual
for a detailed example.

(From yocto-docs rev: ca1e113dc837f5104f765b655880a87d1fbd66ac)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Scott Rifenbark
016e34a2e8 ref-manual: Added the 2.6 Migration Section.
Provided some new sections on the information for migrating from the
2.5 release to the 2.6 release.

(From yocto-docs rev: dd721a31594c753d7229c45ebad0ce11640a0704)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-11-22 12:20:51 +00:00
Kristi Rifenbark
bd4438f4a4 ref-manual: Finalized edits on the 2.5 Migration section
(From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:35 +01:00
Kristi Rifenbark
6da15e51a8 ref-manual: Formatting pass of 2.5 Migration section
(From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:34 +01:00
Kristi Rifenbark
8d751c065d ref-manual: Added 2.5 Migration Section
(From yocto-docs rev: 5d6c1b69e5559eced5142f46421302f61c95404c)

Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:33 +01:00
Scott Rifenbark
5776e0bcd1 ref-manual: Added "section" as part of a reference to the bitbake-user-manual.
Missing this conventional part of the reference contextual diatribe.

(From yocto-docs rev: 5468ebf21bc9166de35e9b7016eef06ed586e5c3)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
1b2b0a267d ref-manual: Removed several redundant links to variables.
Trying to get back to a standard of using an actual link for only
the first occurrence of a variable in any given section.

(From yocto-docs rev: 68d80a5dd8481f938892473c4671a9c436e80c8f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
11c4aa61c1 ref-manual: Removed redundant links to the DISTRO_FEATURES variable.
(From yocto-docs rev: d834e5f5cef520b80e5049b28945cfa1ead3b092)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
ade3eec9f4 ref-manual: Fixed bad title for the bitbake-user-manual
In the migration section, an older name for the bitbake-user-manual
was being used in the text for a cross-reference.  I replaced it
with the current and correct name.

(From yocto-docs rev: 3f466b59a3138984cceae12ac58c84ec3cda4432)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
e467a8ceca ref-manual: Fixed bad link to naked sdk-manual
In the migration section, an older flavor of the title to the
sdk-manual was being used.  This of course was not processed
correctly by the mega-manual.sed script.  I fixed the title so
it is now processed correctly.

(From yocto-docs rev: 1f9fa699bb14f96a7c9ccab314a7d72e6a93dda6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
f5590e221a ref-manual: Fixed bad title string for "Toaster User Manual"
(From yocto-docs rev: 14efbdbbcffea3a301dd220b3336fd11e1878ff8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
a6298bf144 ref-manual: Removed redundant paragraph for links to variables.
(From yocto-docs rev: 32228c3e138d6bd0076b164980e90fdc25c62768)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
cf4fd9a7b5 ref-manual: Fixed mis-matched title in link to ptest.
(From yocto-docs rev: d203312ede89d5c7467f8ac8117522c4fc1fd7b5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
4ea244eac3 ref-manual: Removed redundant link to the BAD_RECOMMENDATIONS variable.
(From yocto-docs rev: 27ce95176fcceb95065eee19fecc2a71d88a0984)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
869796c0eb ref-manual: Removed redundant link to IMAGE_FEATURES variable.
(From yocto-docs rev: 0ca8dc6aa8e06405e9483398788f4e221408fed7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:17 +01:00
Scott Rifenbark
1b877bc9dd documentation: Updated everything for new overview-manual
This involved changing the root manual folder from
"getting-started" to "overview-manual".

Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was
changed to "YOCTO_DOCS_OM_URL".  Most manuals had several
occurrences of these links.

The makefile needed updating to process the new manual
and not process the old "getting-started" manual.

(From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:13 +01:00
Scott Rifenbark
ef25f6b950 mega-manual: Fixed various links to the dev-manual
Found a few links that were not using the correct wording when
referencing a section to the dev-manual.  Also, fixed one link
that was assuming a section outside the dev-manual when the
link was to a section inside the dev-manual.

(From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24 17:16:08 +01: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
355103f8cf dev-manual, ref-manual: Moved build history info to dev-manual
Fixes [YOCTO #12370]

The section in the ref-manual on build history has been moved to
the dev-manual.  It is more of a "how-to" piece of information than
a reference.

(From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c)

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
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
Kristi Rifenbark
a52dc0a11e ref-manual: Added the GCCPIE Variable to Glossary
(From yocto-docs rev: b30f3d3bd6f6d333b00fc9c3797126a898fb0685)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
5d9d10704f ref-manual: Added kernel-devicetree to the Classes section
(From yocto-docs rev: 1ea1f0dc6451030738c506c4d6228b31f67f3f36)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
3f0cd2a1d7 ref-manual: Added the BB_SERVER_TIMEOUT variable to glossary
(From yocto-docs rev: 6e765f4017ae300f83839201b123afa2a3662d70)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-12-09 14:29:07 +00:00
Kristi Rifenbark
69a6e223f9 ref-manual: 2.4 Migration Revisions
(From yocto-docs rev: 0802de0ca64b7d3581fb2e3ff26d2f72802ade61)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:19 +00:00
Kristi Rifenbark
b034103ce6 ref-manual: 2.4 Migration Revisions
(From yocto-docs rev: 1778a743ba3a8b82e96d1e9948e86048d77a8e77)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-11-12 06:51:19 +00:00
Kristi Rifenbark
4cbdb705de ref-manual: First draft of the 2.4 Migration section
(From yocto-docs rev: e0302faa6e7c4ef17c57489e6e6f11b73d8e9b94)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30 15:55:08 +00:00