summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-02-24 16:13:56 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-25 12:29:37 +0000
commit3e0d53269f75cf7fb5487bd7b0f4d187f36fcfc1 (patch)
tree3c8cd600cdbcfe3df9c12bf5dd93d0ce47869360 /documentation
parent2da4610ba7dd66c0956a7c8ed573b7da5d7e437a (diff)
downloadpoky-3e0d53269f75cf7fb5487bd7b0f4d187f36fcfc1.tar.gz
ref-manual: Updates to "Maintaining Build Output Quality"
I modified a few areas to help integrate some newly documented BUILDHISTORY_* variables. Mostly some rewriting to feature some variables that help the user select build history features. (From yocto-docs rev: 8cb6a09ba7f0bd645a12e6f7a93247a9f0e77980) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/usingpoky.xml34
1 files changed, 27 insertions, 7 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index eff8480e1a..1d75a9994e 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -445,7 +445,9 @@
445 </para> 445 </para>
446 446
447 <para> 447 <para>
448 The <filename>buildhistory</filename> class exists to help you maintain 448 The
449 <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
450 class exists to help you maintain
449 the quality of your build output. 451 the quality of your build output.
450 You can use the class to highlight unexpected and possibly unwanted 452 You can use the class to highlight unexpected and possibly unwanted
451 changes in the build output. 453 changes in the build output.
@@ -506,8 +508,10 @@
506 508
507 <para> 509 <para>
508 To disable the build history functionality without causing the 510 To disable the build history functionality without causing the
509 packaging tasks to be re-run, add this statement to your 511 packaging tasks to be re-run, set the
510 <filename>conf/local.conf</filename> file: 512 <link linkend='var-BUILDHISTORY_FEATURES'><filename>BUILDHISTORY_FEATURES</filename></link>
513 variable as follows in your <filename>conf/local.conf</filename>
514 file:
511 <literallayout class='monospaced'> 515 <literallayout class='monospaced'>
512 BUILDHISTORY_FEATURES = "" 516 BUILDHISTORY_FEATURES = ""
513 </literallayout> 517 </literallayout>
@@ -520,7 +524,9 @@
520 <para> 524 <para>
521 Build history information is kept in 525 Build history information is kept in
522 <filename>$</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/buildhistory</filename> 526 <filename>$</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/buildhistory</filename>
523 in the Build Directory. 527 in the Build Directory as defined by the
528 <link linkend='var-BUILDHISTORY_DIR'><filename>BUILDHISTORY_DIR</filename></link>
529 variable.
524 The following is an example abbreviated listing: 530 The following is an example abbreviated listing:
525 <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" /> 531 <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" />
526 </para> 532 </para>
@@ -721,16 +727,19 @@
721 including dependency graphs, so you can see why something 727 including dependency graphs, so you can see why something
722 was pulled into the image. 728 was pulled into the image.
723 If you are just interested in this information and not 729 If you are just interested in this information and not
724 interested in collecting history or any package information, 730 interested in collecting specific package or SDK information,
725 you can enable writing only image information without 731 you can enable writing only image information without
726 any history by adding the following 732 any history by adding the following to your
727 to your <filename>conf/local.conf</filename> file found in the 733 <filename>conf/local.conf</filename> file found in the
728 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: 734 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
729 <literallayout class='monospaced'> 735 <literallayout class='monospaced'>
730 INHERIT += "buildhistory" 736 INHERIT += "buildhistory"
731 BUILDHISTORY_COMMIT = "0" 737 BUILDHISTORY_COMMIT = "0"
732 BUILDHISTORY_FEATURES = "image" 738 BUILDHISTORY_FEATURES = "image"
733 </literallayout> 739 </literallayout>
740 Here, you set the
741 <link linkend='var-BUILDHISTORY_FEATURES'><filename>BUILDHISTORY_FEATURES</filename></link>
742 variable to use the image feature only.
734 </para> 743 </para>
735 </section> 744 </section>
736 745
@@ -741,6 +750,17 @@
741 of SDKs (e.g., <filename>meta-toolchain</filename> 750 of SDKs (e.g., <filename>meta-toolchain</filename>
742 or <filename>bitbake -c populate_sdk imagename</filename>) 751 or <filename>bitbake -c populate_sdk imagename</filename>)
743 as compared to information it collects for images. 752 as compared to information it collects for images.
753 If you want information on the SDK, you need to list that
754 feature using the
755 <link linkend='var-BUILDHISTORY_FEATURES'><filename>BUILDHISTORY_FEATURES</filename></link>
756 variable as follows in your <filename>conf/local.conf</filename>
757 file found in the
758 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
759 <literallayout class='monospaced'>
760 INHERIT += "buildhistory"
761 BUILDHISTORY_COMMIT = "0"
762 BUILDHISTORY_FEATURES = "sdk"
763 </literallayout>:
744 The following list shows the files produced for each SDK: 764 The following list shows the files produced for each SDK:
745 <itemizedlist> 765 <itemizedlist>
746 <listitem><para><filename>files-in-sdk.txt:</filename> 766 <listitem><para><filename>files-in-sdk.txt:</filename>