ref-manual: Minor edits to "Enabling and Disabling Build History"

(From yocto-docs rev: 2d23ad6f5f9047d37496f686dd1f9d8265ee7d55)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2013-03-26 11:10:07 -07:00
committed by Richard Purdie
parent 32d403e643
commit c869fe541c

View File

@@ -409,7 +409,7 @@
<title>Maintaining Build Output Quality</title> <title>Maintaining Build Output Quality</title>
<para> <para>
A build's quality can be influenced by many things. Many factors can influence the quality of a build.
For example, if you upgrade a recipe to use a new version of an upstream software For example, if you upgrade a recipe to use a new version of an upstream software
package or you experiment with some new configuration options, subtle changes package or you experiment with some new configuration options, subtle changes
can occur that you might not detect until later. can occur that you might not detect until later.
@@ -417,7 +417,7 @@
In this case, a new version of a piece of software might introduce an optional In this case, a new version of a piece of software might introduce an optional
dependency on another library, which is auto-detected. dependency on another library, which is auto-detected.
If that library has already been built when the software is building, If that library has already been built when the software is building,
then the software will link to the built library and that library will be pulled the software will link to the built library and that library will be pulled
into your image along with the new software even if you did not want the into your image along with the new software even if you did not want the
library. library.
</para> </para>
@@ -427,7 +427,7 @@
the quality of your build output. the quality of your build output.
You can use the class to highlight unexpected and possibly unwanted You can use the class to highlight unexpected and possibly unwanted
changes in the build output. changes in the build output.
When you enable build history it records information about the contents of When you enable build history, it records information about the contents of
each package and image and then commits that information to a local Git each package and image and then commits that information to a local Git
repository where you can examine the information. repository where you can examine the information.
</para> </para>
@@ -478,13 +478,13 @@
are using the OEBasicHash signature generator (the default are using the OEBasicHash signature generator (the default
for many current distro configurations including for many current distro configurations including
<filename>DISTRO = "poky"</filename> and <filename>DISTRO = "poky"</filename> and
<filename>DISTRO = ""</filename>) will result in the packaging <filename>DISTRO = ""</filename>) and will result in the packaging
tasks being re-run during the subsequent build. tasks being re-run during the subsequent build.
</para> </para>
<para> <para>
To disable the build history functionality without causing the To disable the build history functionality without causing the
packaging tasks to be re-run, add just this statement to your packaging tasks to be re-run, add this statement to your
<filename>conf/local.conf</filename> file: <filename>conf/local.conf</filename> file:
<literallayout class='monospaced'> <literallayout class='monospaced'>
BUILDHISTORY_FEATURES = "" BUILDHISTORY_FEATURES = ""
@@ -497,7 +497,7 @@
<para> <para>
Build history information is kept in Build history information is kept in
<link linkend='var-TMPDIR'><filename>$TMPDIR</filename></link><filename>/buildhistory</filename> <filename>$</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/buildhistory</filename>
in the Build Directory. in the Build Directory.
The following is an example abbreviated listing: The following is an example abbreviated listing:
<imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" /> <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" />
@@ -523,7 +523,7 @@
/usr/share/idl /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers /usr/share/idl /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers
FILELIST = /etc/busybox.links /etc/init.d/hwclock.sh /bin/busybox /bin/sh FILELIST = /etc/busybox.links /etc/init.d/hwclock.sh /bin/busybox /bin/sh
</literallayout> </literallayout>
Most of these name-value pairs corresponds to variables used Most of these name-value pairs correspond to variables used
to produce the package. to produce the package.
The exceptions are <filename>FILELIST</filename>, which is the The exceptions are <filename>FILELIST</filename>, which is the
actual list of files in the package, and actual list of files in the package, and
@@ -553,28 +553,28 @@
<para> <para>
The files produced for each image are as follows: The files produced for each image are as follows:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>build-id:</emphasis> <listitem><para><filename>build-id:</filename>
Human-readable information about the build configuration Human-readable information about the build configuration
and metadata source revisions.</para></listitem> and metadata source revisions.</para></listitem>
<listitem><para><emphasis>*.dot:</emphasis> <listitem><para><filename>*.dot:</filename>
Dependency graphs for the image that are Dependency graphs for the image that are
compatible with <filename>graphviz</filename>. compatible with <filename>graphviz</filename>.
</para></listitem> </para></listitem>
<listitem><para><emphasis>files-in-image.txt:</emphasis> <listitem><para><filename>files-in-image.txt:</filename>
A list of files in the image with permissions, A list of files in the image with permissions,
owner, group, size, and symlink information. owner, group, size, and symlink information.
</para></listitem> </para></listitem>
<listitem><para><emphasis>image-info.txt:</emphasis> <listitem><para><filename>image-info.txt:</filename>
A text file containing name-value pairs with information A text file containing name-value pairs with information
about the image. about the image.
See the following listing example for more information. See the following listing example for more information.
</para></listitem> </para></listitem>
<listitem><para><emphasis>installed-package-names.txt:</emphasis> <listitem><para><filename>installed-package-names.txt:</filename>
A list of installed packages by name only.</para></listitem> A list of installed packages by name only.</para></listitem>
<listitem><para><emphasis>installed-package-sizes.txt:</emphasis> <listitem><para><filename>installed-package-sizes.txt:</filename>
A list of installed packages ordered by size. A list of installed packages ordered by size.
</para></listitem> </para></listitem>
<listitem><para><emphasis>installed-packages.txt:</emphasis> <listitem><para><filename>installed-packages.txt:</filename>
A list of installed packages with fuill package A list of installed packages with fuill package
filenames.</para></listitem> filenames.</para></listitem>
</itemizedlist> </itemizedlist>
@@ -655,7 +655,7 @@
<para> <para>
A command-line tool called <filename>buildhistory-diff</filename> A command-line tool called <filename>buildhistory-diff</filename>
does exist though that queries the Git repository and prints just does exist, though, that queries the Git repository and prints just
the differences that might be significant in human-readable form. the differences that might be significant in human-readable form.
Here is an example: Here is an example:
<literallayout class='monospaced'> <literallayout class='monospaced'>