ref-manual: Created distrodata and checkpkg tasks, updated distrodata class
Fixes [YOCTO #7894] I created two new task reference sections: distrodata and checkpkg. Also, updated the distrodata class description to reflect the presence of these new tasks. (From yocto-docs rev: 3896cbf640d296dafb5eda37f89bba31a47ca8a5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
54050ffceb
commit
b44d9e553a
|
@ -714,7 +714,9 @@
|
|||
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 <filename>do_distrodata</filename> and
|
||||
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>
|
||||
|
@ -728,6 +730,13 @@
|
|||
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'>
|
||||
|
|
|
@ -31,6 +31,36 @@
|
|||
</para>
|
||||
</section>
|
||||
|
||||
<section id='ref-tasks-checkpkg'>
|
||||
<title><filename>do_checkpkg</filename></title>
|
||||
|
||||
<para>
|
||||
Provides information about the recipe including its upstream
|
||||
version and status.
|
||||
The upstream version and status reveals whether or not a version
|
||||
of the recipe exists upstream and a status of not updated, updated,
|
||||
or unknown.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The <filename>checkpkg</filename> task is included as part of the
|
||||
<link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
|
||||
class.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To build the <filename>checkpkg</filename> task, use the
|
||||
<filename>bitbake</filename> command with the "-c" option and
|
||||
task name:
|
||||
<literallayout class='monospaced'>
|
||||
$ bitbake core-image-minimal -c checkpkg
|
||||
</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-compile'>
|
||||
<title><filename>do_compile</filename></title>
|
||||
|
||||
|
@ -87,6 +117,32 @@
|
|||
</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>
|
||||
|
||||
|
|
Loading…
Reference in New Issue