diff options
Diffstat (limited to 'poky/documentation/ref-manual')
| -rw-r--r-- | poky/documentation/ref-manual/migration.xml | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-classes.xml | 57 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-devtool-reference.xml | 179 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-features.xml | 4 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-tasks.xml | 44 | ||||
| -rw-r--r-- | poky/documentation/ref-manual/ref-variables.xml | 26 |
6 files changed, 173 insertions, 141 deletions
diff --git a/poky/documentation/ref-manual/migration.xml b/poky/documentation/ref-manual/migration.xml index 1ecf5b999..ade8787b4 100644 --- a/poky/documentation/ref-manual/migration.xml +++ b/poky/documentation/ref-manual/migration.xml @@ -2566,9 +2566,7 @@ <link linkend='oe-core'>OE-Core</link>. The change includes <filename>package_regex.inc</filename> and <filename>distro_alias.inc</filename>, which are typically enabled - when using the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class. + when using the <filename>distrodata</filename> class. Additionally, the contents of <filename>upstream_tracking.inc</filename> has now been split out to the relevant recipes. diff --git a/poky/documentation/ref-manual/ref-classes.xml b/poky/documentation/ref-manual/ref-classes.xml index d602851c5..ece47e757 100644 --- a/poky/documentation/ref-manual/ref-classes.xml +++ b/poky/documentation/ref-manual/ref-classes.xml @@ -335,18 +335,6 @@ </para> </section> -<section id='ref-classes-bugzilla'> - <title><filename>bugzilla.bbclass</filename></title> - - <para> - The <filename>bugzilla</filename> class supports setting up an - instance of Bugzilla in which you can automatically files bug reports - in response to build failures. - For this class to work, you need to enable the XML-RPC interface in - the instance of Bugzilla. - </para> -</section> - <section id='ref-classes-buildhistory'> <title><filename>buildhistory.bbclass</filename></title> @@ -714,39 +702,6 @@ </para> </section> -<section id='ref-classes-distrodata'> - <title><filename>distrodata.bbclass</filename></title> - - <para> - The <filename>distrodata</filename> class - provides for automatic checking for upstream recipe updates. - The class creates a comma-separated value (CSV) spreadsheet that - contains information about the recipes. - The information provides the - <link linkend='ref-tasks-distrodata'><filename>do_distrodata</filename></link> - and - <filename>do_distro_check</filename> tasks, which do upstream checking - and also verify if a package is used in multiple major distributions. - </para> - - <para> - The class is not included by default. - To use it, you must set the - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> - variable: - <literallayout class='monospaced'> - INHERIT+= "distrodata" - </literallayout> - </para> - - <para> - The <filename>distrodata</filename> class also provides the - <link linkend='ref-tasks-checkpkg'><filename>do_checkpkg</filename></link> - task, which can be used against a simple recipe or against an - image to get all its recipe information. - </para> -</section> - <section id='ref-classes-distutils'> <title><filename>distutils*.bbclass</filename></title> @@ -776,11 +731,6 @@ some of the <filename>distutils*</filename> classes to provide common Python2 support. </para> - - <para> - The <filename>distutils-tools</filename> class supports recipes for - additional "distutils" tools. - </para> </section> <section id='ref-classes-distutils3'> @@ -2335,13 +2285,16 @@ This check was removed for YP 2.3 release <title><filename>npm.bbclass</filename></title> <para> - Provides support for building Node.js software fetched using the npm - package manager. + Provides support for building Node.js software fetched using the + <ulink url='https://en.wikipedia.org/wiki/Npm_(software)'>node package manager (NPM)</ulink>. <note> Currently, recipes inheriting this class must use the <filename>npm://</filename> fetcher to have dependencies fetched and packaged automatically. </note> + For information on how to create NPM packages, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-node-package-manager-npm-packages'>Creating Node Package Manager (NPM) Packages</ulink>" + section in the Yocto Project Development Tasks Manual. </para> </section> diff --git a/poky/documentation/ref-manual/ref-devtool-reference.xml b/poky/documentation/ref-manual/ref-devtool-reference.xml index b974d0f59..4810d28ad 100644 --- a/poky/documentation/ref-manual/ref-devtool-reference.xml +++ b/poky/documentation/ref-manual/ref-devtool-reference.xml @@ -34,7 +34,7 @@ You can run <filename>devtool --help</filename> to see all the commands: <literallayout class='monospaced'> - $ devtool --help + $ devtool -h NOTE: Starting bitbake server... usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] [--color COLOR] [-h] @@ -43,50 +43,48 @@ OpenEmbedded development tool options: - --basepath BASEPATH Base directory of SDK / build directory - --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it - from the metadata - -d, --debug Enable debug output - -q, --quiet Print only errors - --color COLOR Colorize output (where COLOR is auto, always, never) - -h, --help show this help message and exit + --basepath BASEPATH Base directory of SDK / build directory + --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it + from the metadata + -d, --debug Enable debug output + -q, --quiet Print only errors + --color COLOR Colorize output (where COLOR is auto, always, never) + -h, --help show this help message and exit subcommands: Beginning work on a recipe: - add Add a new recipe - modify Modify the source for an existing recipe - upgrade Upgrade an existing recipe + add Add a new recipe + modify Modify the source for an existing recipe + upgrade Upgrade an existing recipe Getting information: - status Show workspace status - search Search available recipes - latest-version Report the latest version of an existing recipe + status Show workspace status + search Search available recipes + latest-version Report the latest version of an existing recipe + check-upgrade-status Report upgradability for multiple (or all) recipes Working on a recipe in the workspace: - build Build a recipe - rename Rename a recipe file in the workspace - edit-recipe Edit a recipe file - find-recipe Find a recipe file - configure-help Get help on configure script options - update-recipe Apply changes from external source tree to recipe - reset Remove a recipe from your workspace - finish Finish working on a recipe in your workspace + build Build a recipe + rename Rename a recipe file in the workspace + edit-recipe Edit a recipe file + find-recipe Find a recipe file + configure-help Get help on configure script options + update-recipe Apply changes from external source tree to recipe + reset Remove a recipe from your workspace + finish Finish working on a recipe in your workspace Testing changes on target: - deploy-target Deploy recipe output files to live target machine - undeploy-target Undeploy recipe output files in live target machine - build-image Build image including workspace recipe packages + deploy-target Deploy recipe output files to live target machine + undeploy-target Undeploy recipe output files in live target machine + build-image Build image including workspace recipe packages Advanced: - create-workspace Set up workspace in an alternative location - export Export workspace into a tar archive - import Import exported tar archive into workspace - extract Extract the source for an existing recipe - sync Synchronize the source tree for an existing recipe + create-workspace Set up workspace in an alternative location + export Export workspace into a tar archive + import Import exported tar archive into workspace + extract Extract the source for an existing recipe + sync Synchronize the source tree for an existing recipe Use devtool <subcommand> --help to get help on a specific command </literallayout> - </para> - - <para> - As directed in the general help output, you can get more - syntax on a specific command by providing the command - name and using <filename>--help</filename>: + As directed in the general help output, you can get more syntax + on a specific command by providing the command name and using + "--help": <literallayout class='monospaced'> $ devtool add --help NOTE: Starting bitbake server... @@ -429,6 +427,108 @@ </para> </section> + <section id='devtool-checking-on-the-upgrade-status-of-a-recipe'> + <title>Checking on the Upgrade Status of a Recipe</title> + + <para> + Upstream recipes change over time. + Consequently, you might find that you need to determine if you + can upgrade a recipe to a newer version. + </para> + + <para> + To check on the upgrade status of a recipe, use the + <filename>devtool check-upgrade-status</filename> command. + The command displays a table of your current recipe versions, + the latest upstream versions, the email address of the recipe's + maintainer, and any additional information such as commit hash + strings and reasons you might not be able to upgrade a particular + recipe. + <note><title>NOTES:</title> + <itemizedlist> + <listitem><para> + For the <filename>oe-core</filename> layer, recipe + maintainers come from the + <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc'><filename>maintainers.inc</filename></ulink> + file. + </para></listitem> + <listitem><para> + If the recipe is using the + <ulink url='&YOCTO_DOCS_BB_URL;#git-fetcher'>Git fetcher</ulink> + rather than a tarball, the commit hash points to the + commit that matches the recipe's latest version tag. + </para></listitem> + </itemizedlist> + </note> + </para> + + <para> + As with all <filename>devtool</filename> commands, you can get + help on the individual command: + <literallayout class='monospaced'> + $ devtool check-upgrade-status -h + NOTE: Starting bitbake server... + usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]] + + Prints a table of recipes together with versions currently provided by + recipes, and latest upstream versions, when there is a later version available + + arguments: + recipe Name of the recipe to report (omit to report upgrade info for + all recipes) + + options: + -h, --help show this help message and exit + --all, -a Show all recipes, not just recipes needing upgrade + </literallayout> + </para> + + <para> + Unless you provide a specific recipe name on the command line, + the command checks all recipes in all configured layers. + </para> + + <para> + Following is a partial example table that reports on all the + recipes. + Notice the reported reason for not upgrading the + <filename>base-passwd</filename> recipe. + In this example, while a new version is available upstream, + you do not want to use it because the dependency on + <filename>cdebconf</filename> is not easily satisfied. + <note> + When a reason for not upgrading displays, the reason is + usually written into the recipe using the + <filename>RECIPE_NO_UPDATE_REASON</filename> variable. + See the + <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb'><filename>base-passwd.bb</filename></ulink> + recipe for an example. + </note> + <literallayout class='monospaced'> + $ devtool check-upgrade-status + ... + NOTE: acpid 2.0.30 2.0.31 + Ross Burton <ross.burton@intel.com> + NOTE: u-boot-fw-utils 2018.11 2019.01 + Marek Vasut <marek.vasut@gmail.com> + d3689267f92c5956e09cc7d1baa4700141662bff + NOTE: u-boot-tools 2018.11 2019.01 + Marek Vasut <marek.vasut@gmail.com> + d3689267f92c5956e09cc7d1baa4700141662bff + . + . + . + NOTE: base-passwd 3.5.29 3.5.45 + Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version + 3.5.38 requires cdebconf for update-passwd utility + NOTE: busybox 1.29.2 1.30.0 + Andrej Valek <andrej.valek@siemens.com> + NOTE: dbus-test 1.12.10 1.12.12 + Chen Qi <Qi.Chen@windriver.com> + </literallayout> + </para> + </section> + <section id='devtool-upgrading-a-recipe'> <title>Upgrading a Recipe</title> @@ -443,6 +543,13 @@ section of the Yocto Project Development Tasks Manual. This section overviews the <filename>devtool upgrade</filename> command. + <note> + Before you upgrade a recipe, you can check on its upgrade + status. + See the + "<link linkend='devtool-checking-on-the-upgrade-status-of-a-recipe'>Checking on the Upgrade Status of a Recipe</link>" + for more information. + </note> </para> <para> diff --git a/poky/documentation/ref-manual/ref-features.xml b/poky/documentation/ref-manual/ref-features.xml index 7a3555d0b..b057d2d04 100644 --- a/poky/documentation/ref-manual/ref-features.xml +++ b/poky/documentation/ref-manual/ref-features.xml @@ -76,8 +76,6 @@ </para></listitem> <listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive </para></listitem> - <listitem><para><emphasis>irda:</emphasis> Hardware has IrDA support - </para></listitem> <listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard </para></listitem> <listitem><para><emphasis>pcbios:</emphasis> Support for booting through BIOS @@ -190,8 +188,6 @@ support.</para></listitem> <listitem><para><emphasis>ipv6:</emphasis> Include IPv6 support. </para></listitem> - <listitem><para><emphasis>irda:</emphasis> Include IrDA support. - </para></listitem> <listitem><para><emphasis>keyboard:</emphasis> Include keyboard support (e.g. keymaps will be loaded during boot). </para></listitem> diff --git a/poky/documentation/ref-manual/ref-tasks.xml b/poky/documentation/ref-manual/ref-tasks.xml index 8f3ff26d2..011e0d749 100644 --- a/poky/documentation/ref-manual/ref-tasks.xml +++ b/poky/documentation/ref-manual/ref-tasks.xml @@ -158,32 +158,6 @@ </para> </section> - <section id='ref-tasks-distrodata'> - <title><filename>do_distrodata</filename></title> - - <para> - Provides information about the recipe. - </para> - - <para> - The <filename>distrodata</filename> task is included as part of the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class. - </para> - - <para> - To build the <filename>distrodata</filename> task, use the - <filename>bitbake</filename> command with the "-c" option and - task name: - <literallayout class='monospaced'> - $ bitbake core-image-minimal -c distrodata - </literallayout> - By default, the results are stored in - <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> - (e.g. <filename>$BUILD_DIR/tmp/log</filename>). - </para> - </section> - <section id='ref-tasks-fetch'> <title><filename>do_fetch</filename></title> @@ -192,7 +166,8 @@ This task uses the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> variable and the argument's prefix to determine the correct - fetcher module. + <ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>fetcher</ulink> + module. </para> </section> @@ -635,9 +610,18 @@ </para> <para> - The <filename>checkpkg</filename> task is included as part of the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class. + To check the upstream version and status of a recipe, use the + following devtool commands: + <literallayout class='monospaced'> + $ devtool latest-version + $ devtool check-upgrade-status + </literallayout> + See the + "<link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>" + chapter for more information on <filename>devtool</filename>. + See the + "<ulink url='&YOCTO_DOCS_REF_URL;#devtool-checking-on-the-upgrade-status-of-a-recipe'>Checking on the Upgrade Status of a Recipe</ulink>" + section for information on checking the upgrade status of a recipe. </para> <para> diff --git a/poky/documentation/ref-manual/ref-variables.xml b/poky/documentation/ref-manual/ref-variables.xml index 0d01c16dd..12876e3d9 100644 --- a/poky/documentation/ref-manual/ref-variables.xml +++ b/poky/documentation/ref-manual/ref-variables.xml @@ -16629,16 +16629,16 @@ <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class is enabled globally, you can perform a per-recipe - check for what the latest upstream source code version is - by calling + You can perform a per-recipe check for what the latest + upstream source code version is by calling <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. If the recipe source code is provided from Git repositories, the OpenEmbedded build system determines the latest upstream version by picking the latest tag from the list of all repository tags. + </para> + + <para> You can use the <filename>UPSTREAM_CHECK_GITTAGREGEX</filename> variable to provide a regular expression to filter only the @@ -16658,11 +16658,8 @@ <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class is enabled globally, use the - <filename>UPSTREAM_CHECK_REGEX</filename> variable to - specify a different regular expression instead of the + Use the <filename>UPSTREAM_CHECK_REGEX</filename> variable + to specify a different regular expression instead of the default one when the package checking system is parsing the page found using <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>. @@ -16680,12 +16677,9 @@ <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class is enabled globally, you can perform a per-recipe - check for what the latest upstream source code version is - by calling <filename>bitbake -c checkpkg</filename> - <replaceable>recipe</replaceable>. + You can perform a per-recipe check for what the latest + upstream source code version is by calling + <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. If the source code is provided from tarballs, the latest version is determined by fetching the directory listing where the tarball is and attempting to find a later tarball. |