summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.xml11
-rw-r--r--documentation/ref-manual/ref-tasks.xml56
2 files changed, 66 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 3f387a3e1a..71df79fa62 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -714,7 +714,9 @@
714 provides for automatic checking for upstream recipe updates. 714 provides for automatic checking for upstream recipe updates.
715 The class creates a comma-separated value (CSV) spreadsheet that 715 The class creates a comma-separated value (CSV) spreadsheet that
716 contains information about the recipes. 716 contains information about the recipes.
717 The information provides the <filename>do_distrodata</filename> and 717 The information provides the
718 <link linkend='ref-tasks-distrodata'><filename>do_distrodata</filename></link>
719 and
718 <filename>do_distro_check</filename> tasks, which do upstream checking 720 <filename>do_distro_check</filename> tasks, which do upstream checking
719 and also verify if a package is used in multiple major distributions. 721 and also verify if a package is used in multiple major distributions.
720 </para> 722 </para>
@@ -728,6 +730,13 @@
728 INHERIT+= "distrodata" 730 INHERIT+= "distrodata"
729 </literallayout> 731 </literallayout>
730 </para> 732 </para>
733
734 <para>
735 The <filename>distrodata</filename> class also provides the
736 <link linkend='ref-tasks-checkpkg'><filename>do_checkpkg</filename></link>
737 task, which can be used against a simple recipe or against an
738 image to get all its recipe information.
739 </para>
731</section> 740</section>
732 741
733<section id='ref-classes-distutils'> 742<section id='ref-classes-distutils'>
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index b2ecc66269..c46debb55b 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -31,6 +31,36 @@
31 </para> 31 </para>
32 </section> 32 </section>
33 33
34 <section id='ref-tasks-checkpkg'>
35 <title><filename>do_checkpkg</filename></title>
36
37 <para>
38 Provides information about the recipe including its upstream
39 version and status.
40 The upstream version and status reveals whether or not a version
41 of the recipe exists upstream and a status of not updated, updated,
42 or unknown.
43 </para>
44
45 <para>
46 The <filename>checkpkg</filename> task is included as part of the
47 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
48 class.
49 </para>
50
51 <para>
52 To build the <filename>checkpkg</filename> task, use the
53 <filename>bitbake</filename> command with the "-c" option and
54 task name:
55 <literallayout class='monospaced'>
56 $ bitbake core-image-minimal -c checkpkg
57 </literallayout>
58 By default, the results are stored in
59 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
60 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
61 </para>
62 </section>
63
34 <section id='ref-tasks-compile'> 64 <section id='ref-tasks-compile'>
35 <title><filename>do_compile</filename></title> 65 <title><filename>do_compile</filename></title>
36 66
@@ -87,6 +117,32 @@
87 </para> 117 </para>
88 </section> 118 </section>
89 119
120 <section id='ref-tasks-distrodata'>
121 <title><filename>do_distrodata</filename></title>
122
123 <para>
124 Provides information about the recipe.
125 </para>
126
127 <para>
128 The <filename>distrodata</filename> task is included as part of the
129 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
130 class.
131 </para>
132
133 <para>
134 To build the <filename>distrodata</filename> task, use the
135 <filename>bitbake</filename> command with the "-c" option and
136 task name:
137 <literallayout class='monospaced'>
138 $ bitbake core-image-minimal -c distrodata
139 </literallayout>
140 By default, the results are stored in
141 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
142 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
143 </para>
144 </section>
145
90 <section id='ref-tasks-fetch'> 146 <section id='ref-tasks-fetch'>
91 <title><filename>do_fetch</filename></title> 147 <title><filename>do_fetch</filename></title>
92 148