summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-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 @@
4320 Make these following configurations: 4320 Make these following configurations:
4321 <itemizedlist> 4321 <itemizedlist>
4322 <listitem><para> 4322 <listitem><para>
4323 Enable "distrodata" as follows:
4324 <literallayout class='monospaced'>
4325 INHERIT =+ "distrodata"
4326 </literallayout>
4327 </para></listitem>
4328 <listitem><para>
4329 If you want to enable 4323 If you want to enable
4330 <ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Build History</ulink>, 4324 <ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Build History</ulink>,
4331 which is optional, you need the following 4325 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 @@
2566 <link linkend='oe-core'>OE-Core</link>. 2566 <link linkend='oe-core'>OE-Core</link>.
2567 The change includes <filename>package_regex.inc</filename> and 2567 The change includes <filename>package_regex.inc</filename> and
2568 <filename>distro_alias.inc</filename>, which are typically enabled 2568 <filename>distro_alias.inc</filename>, which are typically enabled
2569 when using the 2569 when using the <filename>distrodata</filename> class.
2570 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
2571 class.
2572 Additionally, the contents of 2570 Additionally, the contents of
2573 <filename>upstream_tracking.inc</filename> has now been split out 2571 <filename>upstream_tracking.inc</filename> has now been split out
2574 to the relevant recipes. 2572 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 @@
714 </para> 714 </para>
715</section> 715</section>
716 716
717<section id='ref-classes-distrodata'>
718 <title><filename>distrodata.bbclass</filename></title>
719
720 <para>
721 The <filename>distrodata</filename> class
722 provides for automatic checking for upstream recipe updates.
723 The class creates a comma-separated value (CSV) spreadsheet that
724 contains information about the recipes.
725 The information provides the
726 <link linkend='ref-tasks-distrodata'><filename>do_distrodata</filename></link>
727 and
728 <filename>do_distro_check</filename> tasks, which do upstream checking
729 and also verify if a package is used in multiple major distributions.
730 </para>
731
732 <para>
733 The class is not included by default.
734 To use it, you must set the
735 <link linkend='var-INHERIT'><filename>INHERIT</filename></link>
736 variable:
737 <literallayout class='monospaced'>
738 INHERIT+= "distrodata"
739 </literallayout>
740 </para>
741
742 <para>
743 The <filename>distrodata</filename> class also provides the
744 <link linkend='ref-tasks-checkpkg'><filename>do_checkpkg</filename></link>
745 task, which can be used against a simple recipe or against an
746 image to get all its recipe information.
747 </para>
748</section>
749
750<section id='ref-classes-distutils'> 717<section id='ref-classes-distutils'>
751 <title><filename>distutils*.bbclass</filename></title> 718 <title><filename>distutils*.bbclass</filename></title>
752 719
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 @@
158 </para> 158 </para>
159 </section> 159 </section>
160 160
161 <section id='ref-tasks-distrodata'>
162 <title><filename>do_distrodata</filename></title>
163
164 <para>
165 Provides information about the recipe.
166 </para>
167
168 <para>
169 The <filename>distrodata</filename> task is included as part of the
170 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
171 class.
172 </para>
173
174 <para>
175 To build the <filename>distrodata</filename> task, use the
176 <filename>bitbake</filename> command with the "-c" option and
177 task name:
178 <literallayout class='monospaced'>
179 $ bitbake core-image-minimal -c distrodata
180 </literallayout>
181 By default, the results are stored in
182 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
183 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
184 </para>
185 </section>
186
187 <section id='ref-tasks-fetch'> 161 <section id='ref-tasks-fetch'>
188 <title><filename>do_fetch</filename></title> 162 <title><filename>do_fetch</filename></title>
189 163
@@ -636,9 +610,15 @@
636 </para> 610 </para>
637 611
638 <para> 612 <para>
639 The <filename>checkpkg</filename> task is included as part of the 613 To check the upstream version and status of a recipe, use the
640 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 614 following devtool commands:
641 class. 615 <literallayout class='monospaced'>
616 $ devtool latest-version
617 $ devtool check-upgrade-status
618 </literallayout>
619 See the
620 "<link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>"
621 chapter for more information on <filename>devtool</filename>.
642 </para> 622 </para>
643 623
644 <para> 624 <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 @@
16629 <glossdef> 16629 <glossdef>
16630 <para role="glossdeffirst"> 16630 <para role="glossdeffirst">
16631<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 16631<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
16632 When the 16632 You can perform a per-recipe check for what the latest
16633 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 16633 upstream source code version is by calling
16634 class is enabled globally, you can perform a per-recipe
16635 check for what the latest upstream source code version is
16636 by calling
16637 <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. 16634 <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>.
16638 If the recipe source code is provided from Git 16635 If the recipe source code is provided from Git
16639 repositories, the OpenEmbedded build system determines the 16636 repositories, the OpenEmbedded build system determines the
16640 latest upstream version by picking the latest tag from the 16637 latest upstream version by picking the latest tag from the
16641 list of all repository tags. 16638 list of all repository tags.
16639 </para>
16640
16641 <para>
16642 You can use the 16642 You can use the
16643 <filename>UPSTREAM_CHECK_GITTAGREGEX</filename> 16643 <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
16644 variable to provide a regular expression to filter only the 16644 variable to provide a regular expression to filter only the
@@ -16658,11 +16658,8 @@
16658 <glossdef> 16658 <glossdef>
16659 <para role="glossdeffirst"> 16659 <para role="glossdeffirst">
16660<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 16660<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
16661 When the 16661 Use the <filename>UPSTREAM_CHECK_REGEX</filename> variable
16662 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 16662 to specify a different regular expression instead of the
16663 class is enabled globally, use the
16664 <filename>UPSTREAM_CHECK_REGEX</filename> variable to
16665 specify a different regular expression instead of the
16666 default one when the package checking system is parsing 16663 default one when the package checking system is parsing
16667 the page found using 16664 the page found using
16668 <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>. 16665 <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>.
@@ -16680,12 +16677,9 @@
16680 <glossdef> 16677 <glossdef>
16681 <para role="glossdeffirst"> 16678 <para role="glossdeffirst">
16682<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 16679<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
16683 When the 16680 You can perform a per-recipe check for what the latest
16684 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 16681 upstream source code version is by calling
16685 class is enabled globally, you can perform a per-recipe 16682 <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>.
16686 check for what the latest upstream source code version is
16687 by calling <filename>bitbake -c checkpkg</filename>
16688 <replaceable>recipe</replaceable>.
16689 If the source code is provided from tarballs, the latest 16683 If the source code is provided from tarballs, the latest
16690 version is determined by fetching the directory listing 16684 version is determined by fetching the directory listing
16691 where the tarball is and attempting to find a later tarball. 16685 where the tarball is and attempting to find a later tarball.