summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-04-12 12:55:29 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-04-12 22:25:17 +0100
commit8dbf71b553b3fb3063ab5f61bb3454a6ab8e6c08 (patch)
treebdadb9f116fb99e19afa370e34ec3e4c51a23170 /bitbake/doc
parentadde3395966018579e629d97faa3cbfa19e2cac3 (diff)
downloadpoky-8dbf71b553b3fb3063ab5f61bb3454a6ab8e6c08.tar.gz
bitbake: bitbake-user-manual: Updated "Task Checksums and Setscene" sectionuninative-1.9
Fixes [#YOCTO 12030] Updated the "Task Checksums and Setscene" section to provide a bit of user information around the bitbake-dumpsigs use that lets a user examine signatures and inputs that determine if a do_compile task is indeed supposed to be run. Added more explanation of how a user can examine signatures used to determine if a do_compile task is indeed supposed to be run. (Bitbake rev: 103bbc6642261cd5da038ba2071621919ee01253) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml74
1 files changed, 46 insertions, 28 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 32be1789dc..b4fc64e753 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -2651,53 +2651,71 @@
2651 OpenEmbedded metadata-based example. 2651 OpenEmbedded metadata-based example.
2652 </para> 2652 </para>
2653 2653
2654<!--
2655 <para> 2654 <para>
2656 Bug 12030: This list is a place holder of content existed from previous work 2655 These checksums are stored in
2657 on the manual. 2656 <link linkend='var-STAMP'><filename>STAMP</filename></link>.
2658 Some or all of it probably needs integrated into the subsections 2657 You can examine the checksums using the following BitBake command:
2659 that make up this section. 2658 <literallayout class='monospaced'>
2660 For now, I have just provided a short glossary-like description 2659 $ bitbake-dumpsigs
2661 for each variable. 2660 </literallayout>
2661 This command returns the signature data in a readable format
2662 that allows you to examine the inputs used when the
2663 OpenEmbedded build system generates signatures.
2664 For example, using <filename>bitbake-dumpsigs</filename>
2665 allows you to examine the <filename>do_compile</filename>
2666 task's “sigdata” for a C application (e.g.
2667 <filename>bash</filename>).
2668 Running the command also reveals that the “CC” variable is part of
2669 the inputs that are hashed.
2670 Any changes to this variable would invalidate the stamp and
2671 cause the <filename>do_compile</filename> task to run.
2662 </para> 2672 </para>
2663-->
2664 2673
2665 <para> 2674 <para>
2666 The following list describes related variables: 2675 The following list describes related variables:
2667 <itemizedlist> 2676 <itemizedlist>
2668 <listitem><para><filename>STAMP</filename>: 2677 <listitem><para>
2669 The base path to create stamp files.</para></listitem> 2678 <link linkend='var-BB_HASHCHECK_FUNCTION'><filename>BB_HASHCHECK_FUNCTION</filename></link>:
2670 <listitem><para><filename>STAMPCLEAN</filename>
2671 Again, the base path to create stamp files but can use wildcards
2672 for matching a range of files for clean operations.
2673 </para></listitem>
2674 <listitem><para><filename>BB_STAMP_WHITELIST</filename>
2675 Lists stamp files that are looked at when the stamp policy
2676 is "whitelist".
2677 </para></listitem>
2678 <listitem><para><filename>BB_STAMP_POLICY</filename>
2679 Defines the mode for comparing timestamps of stamp files.
2680 </para></listitem>
2681 <listitem><para><filename>BB_HASHCHECK_FUNCTION</filename>
2682 Specifies the name of the function to call during 2679 Specifies the name of the function to call during
2683 the "setscene" part of the task's execution in order 2680 the "setscene" part of the task's execution in order
2684 to validate the list of task hashes. 2681 to validate the list of task hashes.
2685 </para></listitem> 2682 </para></listitem>
2686 <listitem><para><filename>BB_SETSCENE_VERIFY_FUNCTION2</filename> 2683 <listitem><para>
2684 <link linkend='var-BB_SETSCENE_DEPVALID'><filename>BB_SETSCENE_DEPVALID</filename></link>:
2685 Specifies a function BitBake calls that determines
2686 whether BitBake requires a setscene dependency to
2687 be met.
2688 </para></listitem>
2689 <listitem><para>
2690 <link linkend='var-BB_SETSCENE_VERIFY_FUNCTION2'><filename>BB_SETSCENE_VERIFY_FUNCTION2</filename></link>:
2687 Specifies a function to call that verifies the list of 2691 Specifies a function to call that verifies the list of
2688 planned task execution before the main task execution 2692 planned task execution before the main task execution
2689 happens. 2693 happens.
2690 </para></listitem> 2694 </para></listitem>
2691 <listitem><para><filename>BB_SETSCENE_DEPVALID</filename> 2695 <listitem><para>
2692 Specifies a function BitBake calls that determines 2696 <link linkend='var-BB_STAMP_POLICY'><filename>BB_STAMP_POLICY</filename></link>:
2693 whether BitBake requires a setscene dependency to 2697 Defines the mode for comparing timestamps of stamp files.
2694 be met. 2698 </para></listitem>
2699 <listitem><para>
2700 <link linkend='var-BB_STAMP_WHITELIST'><filename>BB_STAMP_WHITELIST</filename></link>:
2701 Lists stamp files that are looked at when the stamp policy
2702 is "whitelist".
2695 </para></listitem> 2703 </para></listitem>
2696 <listitem><para><filename>BB_TASKHASH</filename> 2704 <listitem><para>
2705 <link linkend='var-BB_TASKHASH'><filename>BB_TASKHASH</filename></link>:
2697 Within an executing task, this variable holds the hash 2706 Within an executing task, this variable holds the hash
2698 of the task as returned by the currently enabled 2707 of the task as returned by the currently enabled
2699 signature generator. 2708 signature generator.
2700 </para></listitem> 2709 </para></listitem>
2710 <listitem><para>
2711 <link linkend='var-STAMP'><filename>STAMP</filename></link>:
2712 The base path to create stamp files.
2713 </para></listitem>
2714 <listitem><para>
2715 <link linkend='var-STAMPCLEAN'><filename>STAMPCLEAN</filename></link>:
2716 Again, the base path to create stamp files but can use wildcards
2717 for matching a range of files for clean operations.
2718 </para></listitem>
2701 </itemizedlist> 2719 </itemizedlist>
2702 </para> 2720 </para>
2703 </section> 2721 </section>