summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-23 12:54:35 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-06-07 13:57:41 +0100
commitf21fc9d1be4e6f787bab84c6c407f821882dcf8a (patch)
tree97d0be42865dc429efd016b7f2e83bc302a32a90 /documentation
parentd4fc8cf7ae40180a4afdc3faa614099d99774b80 (diff)
downloadopenembedded-core-contrib-f21fc9d1be4e6f787bab84c6c407f821882dcf8a.tar.gz
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml6
-rw-r--r--documentation/ref-manual/migration.xml4
-rw-r--r--documentation/ref-manual/ref-classes.xml33
-rw-r--r--documentation/ref-manual/ref-tasks.xml38
-rw-r--r--documentation/ref-manual/ref-variables.xml26
5 files changed, 20 insertions, 87 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 8ddcd5b075..9857e95a17 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4320,12 +4320,6 @@
Make these following configurations:
<itemizedlist>
<listitem><para>
- Enable "distrodata" as follows:
- <literallayout class='monospaced'>
- INHERIT =+ "distrodata"
- </literallayout>
- </para></listitem>
- <listitem><para>
If you want to enable
<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Build History</ulink>,
which is optional, you need the following
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 1ecf5b9996..ade8787b4d 100644
--- a/documentation/ref-manual/migration.xml
+++ b/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/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index d602851c54..f5d09dcd73 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -714,39 +714,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>
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 0ad35cdbb8..4f99e18b66 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/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>
@@ -636,9 +610,15 @@
</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>.
</para>
<para>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 0d01c16ddb..12876e3d9a 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/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.