From: Scott Rifenbark <srifenbark@gmail.com>
Date: Mon, 10 Oct 2016 19:49:06 +0000 (-0700)
Subject: bitbake-user-manual: Updated the [noexec] and [nostamp] flag descriptions
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b6a4a6147b9e455cc1fec37553fb577f187a2d73;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

bitbake-user-manual: Updated the [noexec] and [nostamp] flag descriptions

Fixes [YOCTO #10401]

Added some wording to clarify that setting these flags to "1"
causes the desired action.  Also, provided a cautionary note
about tasks depending on any [nostamp] task causes the task
to always be executed and could cause unnecessary rebuild time.

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
---

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index e1b2f2d0b2c..fac54d34d3f 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -1833,14 +1833,23 @@
                      exclusion.
                     </para></listitem>
                 <listitem><para><emphasis><filename>[noexec]</filename>:</emphasis>
-                    Marks the tasks as being empty and no execution required.
-                    The <filename>[noexec]</filename> flag can be used to set up
+                    When set to "1", marks the task as being empty, with
+                    no execution required.
+                    You can use the <filename>[noexec]</filename> flag to set up
                     tasks as dependency placeholders, or to disable tasks defined
                     elsewhere that are not needed in a particular recipe.
                     </para></listitem>
                 <listitem><para><emphasis><filename>[nostamp]</filename>:</emphasis>
-                    Tells BitBake to not generate a stamp file for a task,
-                    which implies the task should always be executed.
+                    When set to "1", tells BitBake to not generate a stamp
+                    file for a task, which implies the task should always
+                    be executed.
+                    <note><title>Caution</title>
+                        Any task that depends (possibly indirectly) on a
+                        <filename>[nostamp]</filename> task will always be
+                        executed as well.
+                        This can cause unnecessary rebuilding if you are
+                        not careful.
+                    </note>
                     </para></listitem>
                 <listitem><para><emphasis><filename>[postfuncs]</filename>:</emphasis>
                     List of functions to call after the completion of the task.