aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-21 12:18:28 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-01 12:15:01 +0100
commit05beac3ef05c38862254b9ba9922961637fb3b72 (patch)
tree6495302530cdebdaca39857024551956c1856076 /documentation/ref-manual
parent376a8201d18f5eb8e06d15d11a6e30f96e8eb43d (diff)
downloadopenembedded-core-contrib-05beac3ef05c38862254b9ba9922961637fb3b72.tar.gz
ref-manual: Added a link to D variable and moved a task:
Fixes [YOCTO #9989] Added a link to the WORKDIR term in the D glossary description example. Also, moved the do_checkpkg task from the section of showing normal recipe build tasks to the the section for manually called tasks. (From yocto-docs rev: 548e2fdfeae9d67bbad73ee3ab69a64a9a6ce9ff) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-tasks.xml60
-rw-r--r--documentation/ref-manual/ref-variables.xml2
2 files changed, 31 insertions, 31 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 22c1e26eb9..37dd0cfd60 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -35,36 +35,6 @@
</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>
@@ -537,6 +507,36 @@
<filename>bitbake -c</filename> command-line option):
</para>
+ <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-checkuri'>
<title><filename>do_checkuri</filename></title>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 2fa7209d47..d31c94c9e3 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2597,7 +2597,7 @@
task.
This location defaults to:
<literallayout class='monospaced'>
- ${WORKDIR}/image
+ ${<link linkend='var-WORKDIR'>WORKDIR</link>}/image
</literallayout>
</para>
</glossdef>