summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
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 0fcb7b7064..7476fbea67 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4319,12 +4319,6 @@
4319 Make these following configurations: 4319 Make these following configurations:
4320 <itemizedlist> 4320 <itemizedlist>
4321 <listitem><para> 4321 <listitem><para>
4322 Enable "distrodata" as follows:
4323 <literallayout class='monospaced'>
4324 INHERIT =+ "distrodata"
4325 </literallayout>
4326 </para></listitem>
4327 <listitem><para>
4328 If you want to enable 4322 If you want to enable
4329 <ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Build History</ulink>, 4323 <ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Build History</ulink>,
4330 which is optional, you need the following 4324 which is optional, you need the following
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 4f57c1e1d3..a4d72dd6b7 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 8f3ff26d24..c7e83cf735 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
@@ -635,9 +609,15 @@
635 </para> 609 </para>
636 610
637 <para> 611 <para>
638 The <filename>checkpkg</filename> task is included as part of the 612 To check the upstream version and status of a recipe, use the
639 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 613 following devtool commands:
640 class. 614 <literallayout class='monospaced'>
615 $ devtool latest-version
616 $ devtool check-upgrade-status
617 </literallayout>
618 See the
619 "<link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>"
620 chapter for more information on <filename>devtool</filename>.
641 </para> 621 </para>
642 622
643 <para> 623 <para>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index dc5c44ecaf..1e3f282a53 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -16626,16 +16626,16 @@
16626 <glossdef> 16626 <glossdef>
16627 <para role="glossdeffirst"> 16627 <para role="glossdeffirst">
16628<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 16628<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
16629 When the 16629 You can perform a per-recipe check for what the latest
16630 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 16630 upstream source code version is by calling
16631 class is enabled globally, you can perform a per-recipe
16632 check for what the latest upstream source code version is
16633 by calling
16634 <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. 16631 <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>.
16635 If the recipe source code is provided from Git 16632 If the recipe source code is provided from Git
16636 repositories, the OpenEmbedded build system determines the 16633 repositories, the OpenEmbedded build system determines the
16637 latest upstream version by picking the latest tag from the 16634 latest upstream version by picking the latest tag from the
16638 list of all repository tags. 16635 list of all repository tags.
16636 </para>
16637
16638 <para>
16639 You can use the 16639 You can use the
16640 <filename>UPSTREAM_CHECK_GITTAGREGEX</filename> 16640 <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
16641 variable to provide a regular expression to filter only the 16641 variable to provide a regular expression to filter only the
@@ -16655,11 +16655,8 @@
16655 <glossdef> 16655 <glossdef>
16656 <para role="glossdeffirst"> 16656 <para role="glossdeffirst">
16657<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 16657<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
16658 When the 16658 Use the <filename>UPSTREAM_CHECK_REGEX</filename> variable
16659 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 16659 to specify a different regular expression instead of the
16660 class is enabled globally, use the
16661 <filename>UPSTREAM_CHECK_REGEX</filename> variable to
16662 specify a different regular expression instead of the
16663 default one when the package checking system is parsing 16660 default one when the package checking system is parsing
16664 the page found using 16661 the page found using
16665 <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>. 16662 <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>.
@@ -16677,12 +16674,9 @@
16677 <glossdef> 16674 <glossdef>
16678 <para role="glossdeffirst"> 16675 <para role="glossdeffirst">
16679<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 16676<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
16680 When the 16677 You can perform a per-recipe check for what the latest
16681 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 16678 upstream source code version is by calling
16682 class is enabled globally, you can perform a per-recipe 16679 <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>.
16683 check for what the latest upstream source code version is
16684 by calling <filename>bitbake -c checkpkg</filename>
16685 <replaceable>recipe</replaceable>.
16686 If the source code is provided from tarballs, the latest 16680 If the source code is provided from tarballs, the latest
16687 version is determined by fetching the directory listing 16681 version is determined by fetching the directory listing
16688 where the tarball is and attempting to find a later tarball. 16682 where the tarball is and attempting to find a later tarball.