summaryrefslogtreecommitdiffstats
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
parent376a8201d18f5eb8e06d15d11a6e30f96e8eb43d (diff)
downloadpoky-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>
-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 @@
35 </para> 35 </para>
36 </section> 36 </section>
37 37
38 <section id='ref-tasks-checkpkg'>
39 <title><filename>do_checkpkg</filename></title>
40
41 <para>
42 Provides information about the recipe including its upstream
43 version and status.
44 The upstream version and status reveals whether or not a version
45 of the recipe exists upstream and a status of not updated, updated,
46 or unknown.
47 </para>
48
49 <para>
50 The <filename>checkpkg</filename> task is included as part of the
51 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
52 class.
53 </para>
54
55 <para>
56 To build the <filename>checkpkg</filename> task, use the
57 <filename>bitbake</filename> command with the "-c" option and
58 task name:
59 <literallayout class='monospaced'>
60 $ bitbake core-image-minimal -c checkpkg
61 </literallayout>
62 By default, the results are stored in
63 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
64 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
65 </para>
66 </section>
67
68 <section id='ref-tasks-compile'> 38 <section id='ref-tasks-compile'>
69 <title><filename>do_compile</filename></title> 39 <title><filename>do_compile</filename></title>
70 40
@@ -537,6 +507,36 @@
537 <filename>bitbake -c</filename> command-line option): 507 <filename>bitbake -c</filename> command-line option):
538 </para> 508 </para>
539 509
510 <section id='ref-tasks-checkpkg'>
511 <title><filename>do_checkpkg</filename></title>
512
513 <para>
514 Provides information about the recipe including its upstream
515 version and status.
516 The upstream version and status reveals whether or not a version
517 of the recipe exists upstream and a status of not updated, updated,
518 or unknown.
519 </para>
520
521 <para>
522 The <filename>checkpkg</filename> task is included as part of the
523 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
524 class.
525 </para>
526
527 <para>
528 To build the <filename>checkpkg</filename> task, use the
529 <filename>bitbake</filename> command with the "-c" option and
530 task name:
531 <literallayout class='monospaced'>
532 $ bitbake core-image-minimal -c checkpkg
533 </literallayout>
534 By default, the results are stored in
535 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
536 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
537 </para>
538 </section>
539
540 <section id='ref-tasks-checkuri'> 540 <section id='ref-tasks-checkuri'>
541 <title><filename>do_checkuri</filename></title> 541 <title><filename>do_checkuri</filename></title>
542 542
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 @@
2597 task. 2597 task.
2598 This location defaults to: 2598 This location defaults to:
2599 <literallayout class='monospaced'> 2599 <literallayout class='monospaced'>
2600 ${WORKDIR}/image 2600 ${<link linkend='var-WORKDIR'>WORKDIR</link>}/image
2601 </literallayout> 2601 </literallayout>
2602 </para> 2602 </para>
2603 </glossdef> 2603 </glossdef>