diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-03-26 11:10:07 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-04 14:12:51 +0100 |
commit | c869fe541cbef56a5af7f6357768d99c61669b64 (patch) | |
tree | 1dfa6f717dc3c63390bd9a60ffa6a0b1664f4447 /documentation | |
parent | 32d403e643b09a964e2cb346046837dec4a6f83d (diff) | |
download | poky-c869fe541cbef56a5af7f6357768d99c61669b64.tar.gz |
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 6acbaabe4e..d0db3f5ae2 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
@@ -409,7 +409,7 @@ | |||
409 | <title>Maintaining Build Output Quality</title> | 409 | <title>Maintaining Build Output Quality</title> |
410 | 410 | ||
411 | <para> | 411 | <para> |
412 | A build's quality can be influenced by many things. | 412 | Many factors can influence the quality of a build. |
413 | For example, if you upgrade a recipe to use a new version of an upstream software | 413 | For example, if you upgrade a recipe to use a new version of an upstream software |
414 | package or you experiment with some new configuration options, subtle changes | 414 | package or you experiment with some new configuration options, subtle changes |
415 | can occur that you might not detect until later. | 415 | can occur that you might not detect until later. |
@@ -417,7 +417,7 @@ | |||
417 | In this case, a new version of a piece of software might introduce an optional | 417 | In this case, a new version of a piece of software might introduce an optional |
418 | dependency on another library, which is auto-detected. | 418 | dependency on another library, which is auto-detected. |
419 | If that library has already been built when the software is building, | 419 | If that library has already been built when the software is building, |
420 | then the software will link to the built library and that library will be pulled | 420 | the software will link to the built library and that library will be pulled |
421 | into your image along with the new software even if you did not want the | 421 | into your image along with the new software even if you did not want the |
422 | library. | 422 | library. |
423 | </para> | 423 | </para> |
@@ -427,7 +427,7 @@ | |||
427 | the quality of your build output. | 427 | the quality of your build output. |
428 | You can use the class to highlight unexpected and possibly unwanted | 428 | You can use the class to highlight unexpected and possibly unwanted |
429 | changes in the build output. | 429 | changes in the build output. |
430 | When you enable build history it records information about the contents of | 430 | When you enable build history, it records information about the contents of |
431 | each package and image and then commits that information to a local Git | 431 | each package and image and then commits that information to a local Git |
432 | repository where you can examine the information. | 432 | repository where you can examine the information. |
433 | </para> | 433 | </para> |
@@ -478,13 +478,13 @@ | |||
478 | are using the OEBasicHash signature generator (the default | 478 | are using the OEBasicHash signature generator (the default |
479 | for many current distro configurations including | 479 | for many current distro configurations including |
480 | <filename>DISTRO = "poky"</filename> and | 480 | <filename>DISTRO = "poky"</filename> and |
481 | <filename>DISTRO = ""</filename>) will result in the packaging | 481 | <filename>DISTRO = ""</filename>) and will result in the packaging |
482 | tasks being re-run during the subsequent build. | 482 | tasks being re-run during the subsequent build. |
483 | </para> | 483 | </para> |
484 | 484 | ||
485 | <para> | 485 | <para> |
486 | To disable the build history functionality without causing the | 486 | To disable the build history functionality without causing the |
487 | packaging tasks to be re-run, add just this statement to your | 487 | packaging tasks to be re-run, add this statement to your |
488 | <filename>conf/local.conf</filename> file: | 488 | <filename>conf/local.conf</filename> file: |
489 | <literallayout class='monospaced'> | 489 | <literallayout class='monospaced'> |
490 | BUILDHISTORY_FEATURES = "" | 490 | BUILDHISTORY_FEATURES = "" |
@@ -497,7 +497,7 @@ | |||
497 | 497 | ||
498 | <para> | 498 | <para> |
499 | Build history information is kept in | 499 | Build history information is kept in |
500 | <link linkend='var-TMPDIR'><filename>$TMPDIR</filename></link><filename>/buildhistory</filename> | 500 | <filename>$</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/buildhistory</filename> |
501 | in the Build Directory. | 501 | in the Build Directory. |
502 | The following is an example abbreviated listing: | 502 | The following is an example abbreviated listing: |
503 | <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" /> | 503 | <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" /> |
@@ -523,7 +523,7 @@ | |||
523 | /usr/share/idl /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers | 523 | /usr/share/idl /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers |
524 | FILELIST = /etc/busybox.links /etc/init.d/hwclock.sh /bin/busybox /bin/sh | 524 | FILELIST = /etc/busybox.links /etc/init.d/hwclock.sh /bin/busybox /bin/sh |
525 | </literallayout> | 525 | </literallayout> |
526 | Most of these name-value pairs corresponds to variables used | 526 | Most of these name-value pairs correspond to variables used |
527 | to produce the package. | 527 | to produce the package. |
528 | The exceptions are <filename>FILELIST</filename>, which is the | 528 | The exceptions are <filename>FILELIST</filename>, which is the |
529 | actual list of files in the package, and | 529 | actual list of files in the package, and |
@@ -553,28 +553,28 @@ | |||
553 | <para> | 553 | <para> |
554 | The files produced for each image are as follows: | 554 | The files produced for each image are as follows: |
555 | <itemizedlist> | 555 | <itemizedlist> |
556 | <listitem><para><emphasis>build-id:</emphasis> | 556 | <listitem><para><filename>build-id:</filename> |
557 | Human-readable information about the build configuration | 557 | Human-readable information about the build configuration |
558 | and metadata source revisions.</para></listitem> | 558 | and metadata source revisions.</para></listitem> |
559 | <listitem><para><emphasis>*.dot:</emphasis> | 559 | <listitem><para><filename>*.dot:</filename> |
560 | Dependency graphs for the image that are | 560 | Dependency graphs for the image that are |
561 | compatible with <filename>graphviz</filename>. | 561 | compatible with <filename>graphviz</filename>. |
562 | </para></listitem> | 562 | </para></listitem> |
563 | <listitem><para><emphasis>files-in-image.txt:</emphasis> | 563 | <listitem><para><filename>files-in-image.txt:</filename> |
564 | A list of files in the image with permissions, | 564 | A list of files in the image with permissions, |
565 | owner, group, size, and symlink information. | 565 | owner, group, size, and symlink information. |
566 | </para></listitem> | 566 | </para></listitem> |
567 | <listitem><para><emphasis>image-info.txt:</emphasis> | 567 | <listitem><para><filename>image-info.txt:</filename> |
568 | A text file containing name-value pairs with information | 568 | A text file containing name-value pairs with information |
569 | about the image. | 569 | about the image. |
570 | See the following listing example for more information. | 570 | See the following listing example for more information. |
571 | </para></listitem> | 571 | </para></listitem> |
572 | <listitem><para><emphasis>installed-package-names.txt:</emphasis> | 572 | <listitem><para><filename>installed-package-names.txt:</filename> |
573 | A list of installed packages by name only.</para></listitem> | 573 | A list of installed packages by name only.</para></listitem> |
574 | <listitem><para><emphasis>installed-package-sizes.txt:</emphasis> | 574 | <listitem><para><filename>installed-package-sizes.txt:</filename> |
575 | A list of installed packages ordered by size. | 575 | A list of installed packages ordered by size. |
576 | </para></listitem> | 576 | </para></listitem> |
577 | <listitem><para><emphasis>installed-packages.txt:</emphasis> | 577 | <listitem><para><filename>installed-packages.txt:</filename> |
578 | A list of installed packages with fuill package | 578 | A list of installed packages with fuill package |
579 | filenames.</para></listitem> | 579 | filenames.</para></listitem> |
580 | </itemizedlist> | 580 | </itemizedlist> |
@@ -655,7 +655,7 @@ | |||
655 | 655 | ||
656 | <para> | 656 | <para> |
657 | A command-line tool called <filename>buildhistory-diff</filename> | 657 | A command-line tool called <filename>buildhistory-diff</filename> |
658 | does exist though that queries the Git repository and prints just | 658 | does exist, though, that queries the Git repository and prints just |
659 | the differences that might be significant in human-readable form. | 659 | the differences that might be significant in human-readable form. |
660 | Here is an example: | 660 | Here is an example: |
661 | <literallayout class='monospaced'> | 661 | <literallayout class='monospaced'> |