Commit Graph

5311 Commits

Author SHA1 Message Date
Richard Purdie
260a215171 documentation: Remove accidentally added files
(From yocto-docs rev: 35f2ae3795a09bdee6d5dd0217f1f5091d8f1ecb)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-01-07 12:22:44 +00:00
Scott Rifenbark
7e7b066085 YP 3.1 Docs: Updated Manual revision tables.
Scrubbed so subsequent releases are relevant to the
initial release only.

(From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16 23:32:33 +00:00
Scott Rifenbark
98e34b71ef poky.ent: Updated variables for YP 3.1
(From yocto-docs rev: 28606ba4bd9994b854ebc790810dfdfb06538c55)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16 23:32:33 +00:00
Scott Rifenbark
292b0cc224 YP Documentation: Set up for YP 3.1 release
* Updates to poky.ent
* Updates to mega-manual.sed
* Updates to all <manual>.xml files for date

(From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09 12:02:54 +00:00
Scott Rifenbark
a1bc1ccf42 dev-manual: Removed duplicate paragraph for selecting init manager.
(From yocto-docs rev: d22e9762cc26b5f5454b446022ee308ffe90e1ef)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09 12:02:54 +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
4426cb3c47 mega-manual: Updated mega-manual Bitbake manual search path
using ../.. instead of ../../..

Fixes [YOCTO #13553]

(From yocto-docs rev: 6611a4726167e8597417e132661a29ec411266cc)

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
ff0db7b88e ref-manual, dev-manual: Added CMake toolchain files.
Fixes [YOCTO #12760]

Updated the cmake.bbclass description to tell what directory
to insall custom CMake toolchain files into.  Also, updated
the two areas in the "Writing a New Recipe" section that
mention CMake.  Placed a couple notes there concerning the
same directory stuff.

(From yocto-docs rev: a65cd2c4c062d4ae388191b9d6708b4fadffaa3f)

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
20d648416b ref-manual: Updated the BUSYBOX_SPLIT_SUID variable.
Fixes [YOCTO #13596]

(From yocto-docs rev: 015991b26ed091385cfb94f13e00c6a964c20160)

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
495bb1e329 ref-manual, dev-manual: Clean up of a commit
Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
commited a change to these manuals (see
9e79e96cad66316c1b4ee608723edfa763f0f9ef) and did not
use YP documentation standards for the content.  I cleaned
up the text and tabbing.

(From yocto-docs rev: 9c95799322e1830a5faae0980384ab10b6504007)

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
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
3eb09fd737 documenation: Changed "2.8" to "3.0".
I was using "2.8" throughout the manual set instead
of "3.0".  Updated all aspects to "3.0".

(From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a)

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
9db609edf7 dev-manual: Added info to "Selecting an Initialization Manager"
(From yocto-docs rev: c402ebcb51b6400d79c62ff44aeae57db982565e)

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
ca2dc29326 poky.ent: Updated the release date to October 2019
(From yocto-docs rev: 21042fd8ad463c996e554f52359a599ee7d35c12)

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
Ross Burton
52a625582e kernel-dev: don't use _append +=
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-15 14:17:58 +01:00
Ross Burton
f574abdf75 ref-system-requirements: update support distribution list
Add Fedora 30 and Ubuntu 19.04.

Swap openSUSE 42.3 for Leap 15.1.

Remove huge comment of old distributions.

(From yocto-docs rev: 8fe3040a68c0aee44c4a6dcd5088b61d6908b0f9)

Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-09 14:05:24 +01:00
Alejandro Enedino Hernandez Samaniego
677bfa6a69 documentation: Update multiconfig syntax and explanation on BBMULTICONFIG
The syntax to use multiconfig builds changed from multiconfig:foo:target
to mc:foo:target.

Clarify that BBMULTICONFIG defines additional configurations along with
the one coming from local.conf.

Fix these changes on both the dev manual and the reference manual.

(From yocto-docs rev: 9e79e96cad66316c1b4ee608723edfa763f0f9ef)

Signed-off-by: Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com>
Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-09 14:01:01 +01:00
Adrian Bunk
3b87508a9a ref-manual: Remove documentation for the removed gnome class
When removed all it did was
  inherit gnomebase gtk-icon-cache gconf mime
which would also be the most trivial replacement.

Most of the time not all of these classes were needed,
and it is recommended to use only the ones actually required.

(From yocto-docs rev: a0a3a8318a1488ad2fb00b29f1cf26a9d6701be2)

Signed-off-by: Adrian Bunk <bunk@stusta.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10 11:21:55 +01:00
Ross Burton
320fd9e28f ref-system-requirements: add Debian 10 to supported distribution list
Debian 10 is a supported distribution now, so add it to the documentation.

(From yocto-docs rev: 77ff109cf7dbe1858e9959c4b9f1225d0a1c5e32)

Signed-off-by: Ross Burton <ross.burton@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10 11:21:55 +01:00
Adrian Bunk
b5b5f90a79 ref-manual: Remove documentation for the removed bluez5 distro feature
bluez4 was removed even from meta-oe 2 years ago,
which made made the bluez5 feature for selecting between
bluez4 and bluez5 mandatory for using the bluetooth feature.

The backfilled bluez5 feature has been removed,
including the bluetooth class that helped recipes
for selecting between bluez4/bluez5.
Recipes can replace ${BLUEZ} with bluez5.

(From yocto-docs rev: 025e2b5797b987b0260d7410e2e6d7283f5a7e91)

Signed-off-by: Adrian Bunk <bunk@stusta.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10 11:21:55 +01:00
Scott Rifenbark
196561b696 ref-manual: sync list of image types with source
(From yocto-docs rev: fc2817a4ca75efcb556c84ba5c6edcb4d703a78f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
36500d9d87 poky-end: Added "pylint3" package to Ubuntu essentials.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Adrian Bunk
7b989f563f Update to KERNEL_DEVICETREE variable.
Corrected the requirements for the KERNEL_DEVCIETREE
variable example.

(From yocto-docs rev: 0502910c81f4d669457155ed5f52d5fa775d8d6d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
7f04f85f71 dev-manual: Updated "Creating a Team Development Environment"
This section needed the wording updated.

(From yocto-docs rev: dd9e09273e9e5d5b6b43bf508f50d4d57e0dc569)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
01a4b3f0a0 ref-manual: Updates to "Building Your Recipe"
(From yocto-docs rev: 6aa1fe818c284c1d740ce8063d58c664e73d380d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
cfa0507589 ref-manual: Updated the "AS" variable
(From yocto-docs rev: ebd659999da3c465e1dbe3fb07d5eedbb6ff4c8f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06 11:59:45 +01:00
Scott Rifenbark
1370f3ad2e ref-manual: Removed "python2" mention in example.
We are not using Python2.  I removed this instance in the ref
manual. The variable "PYTHON_PN" referenced Python 2.  It no
longer does.

(From yocto-docs rev: bd2ed0c640e12e8010ebff0aaba77e8fe367d63e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
1cf94948b7 ref-manual: Fixed typo for BBMULTICONFIG variable.
There was a typo in the BBMULTICONFIG variable description.
It appeared as "BBMULTIFONFIG". I fixed it.

(From yocto-docs rev: c53b1bb6e588f9ee87cb8ab85fc8c3985257a37a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
bcd50509bf dev-manual: Provided proper link title
In the "Enabling GObject Introspection Support" section, a link
existed to the "Known Issues" section further down in the
chapter.  The target of the link was missing and appeared as the
placeholder "xxx".  I put in the proper link.

(From yocto-docs rev: 8d0d1b2104f08e888075bc0ae0bed4f0ec2f4ea6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
25efbee1d7 sdk-manual: Updated devtool to talk about oe-local-files.
Fixes YOCTO #13079

Bug is about making sure the section on the devtool command
talks about oe-local-files.  Two devtool commands (modify
and upgrade) needed to mention the role of the oe-local-files
area and how it is used during these commands.  I updated the
appropriate sections:

 * Use devtool modify to Modify the Source of an Existing Component
 * Use devtool upgrade to Create a Version of the Recipe that
   Supports a Newer Version of the Software.

(From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
f3c76f8fd6 overview-manual: Fixed manual history table
Missing information for some of the releases put back in.

(From yocto-docs rev: f4c09ab9eda925c16946d9d6cf58d1e40d8f6a07)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18 12:16:53 +01:00
Scott Rifenbark
111b7173fe dev-manual: Fixed grammar issue.
Fixed in "Selecting an Initialization Manager" section.
Extraneous word needed removed.

(From yocto-docs rev: ab97d36299a7a648bc3f3325175d8ab633ad2d1a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
ab69e1917f overview-manual: Updated SCM section
Fixes [YOCTO #10098]

I updated the "Source Control Managers (Optional)" section
to reference the "Fetchers" section in the BB manuual.

(From yocto-docs rev: 0c014fba509d3ec28236e63a7bd2355b447c4acf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
b0b59bd2b8 ref-manual: Updated "npm.bbclass" section.
I provided a general link to the wiki on npm software.
Also, updated the section to point to the new section on how to
create NPM packages, which is in the dev-manual.

(From yocto-docs rev: 03fd635d06d64a53ad00196919350a45942731ce)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
4f44204d1a dev-manual: Updated the "Working with Packages" list
I added the "Creating node package manager (NPM) packages
section link to the list.  Also, made some edits to make
the capitalization consistent in the list items.

(From yocto-docs rev: d3e345cd3f44e9588c5fe8f0560e1859df0ff496)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
688fee4596 Makefile: Updated to support new NPM package creation section
The newly created section on how to create NPM packages
required a figure.  I added the figure to both the dev-manual
and mega-manual tarballs creation areas.

(From yocto-docs rev: 5109274d107b6d3ae6be3f71a20379cb6abb39d6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
Scott Rifenbark
c19e706b2c dev-manual: Added new section for creating NPM packages
Fixes [YOCTO #10098]

This is a new section in the development tasks manual that describes
how to create Node Package Manager (NPM) packages.  I put the
section in the "Working with Packages" section.

(From yocto-docs rev: d7acd9f27418d414854d25bb27842407edfe7dda)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18 11:29:23 +01:00
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
40233c62f8 dev-manual: Added check-upgrade-status blurb to upgrading recipes
The section "Upgrading Recipes" covers several ways of
upgrading a recipe.  I added some stuff in the introductory
area that mentions the fact a user might want to check
the upgrade status of a recipe first.

(From yocto-docs rev: bd2fd8d0a91b64455c282ebf4974e40874274f46)

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