summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-04 07:51:37 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-10 16:20:53 +0100
commite822444f5cc67e25463367826c9dea1861c92061 (patch)
tree24640c2587d9b0281a9a197d6b23f7828ed1270b /documentation/ref-manual
parentea8e60842d77491c4d83c5d017e7b6d1920b950b (diff)
downloadpoky-e822444f5cc67e25463367826c9dea1861c92061.tar.gz
ref-manual: Edits applied to buildhistory patch 2 of 5.
Did some rewriting to conform to the manual's style and formatting. (From yocto-docs rev: 6a961978b207d8992ade86f82838914b858accdb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/usingpoky.xml65
1 files changed, 39 insertions, 26 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index 677b5a21a7..778d053cd6 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -547,12 +547,15 @@
547 </para> 547 </para>
548 548
549 <para> 549 <para>
550 Finally, for those recipes that are fetched from a version control 550 Finally, for those recipes fetched from a version control
551 system (such as Git) there is a file that lists the source revision(s) 551 system (e.g., Git), a file exists that lists source revisions
552 specified in the recipe and the actual revision used when building 552 that are specified in the recipe and lists the actual revisions
553 (which may be different when <filename>SRCREV</filename> is set to 553 used during the build.
554 <filename>${AUTOREV}</filename> for example). Here is an example 554 Listed and actual revisions might differ when
555 of one of these files: 555 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
556 is set to
557 <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>.
558 Here is an example assuming
556 <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>): 559 <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>):
557 <literallayout class='monospaced'> 560 <literallayout class='monospaced'>
558 # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" 561 # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf"
@@ -565,8 +568,9 @@
565 You can use the <filename>buildhistory-collect-srcrevs</filename> 568 You can use the <filename>buildhistory-collect-srcrevs</filename>
566 command to collect the stored <filename>SRCREV</filename> values 569 command to collect the stored <filename>SRCREV</filename> values
567 from build history and report them in a format suitable for use in 570 from build history and report them in a format suitable for use in
568 global configuration (for example, local.conf or a distro include 571 global configuration (e.g., <filename>local.conf</filename>
569 file) to override floating AUTOREV values to a fixed set of revisions. 572 or a distro include file) to override floating
573 <filename>AUTOREV</filename> values to a fixed set of revisions.
570 Here is some example output from this command: 574 Here is some example output from this command:
571 <literallayout class='monospaced'> 575 <literallayout class='monospaced'>
572 # emenlow-poky-linux 576 # emenlow-poky-linux
@@ -578,24 +582,33 @@
578 SRCREV_pn-blktrace = "d6918c8832793b4205ed3bfede78c2f915c23385" 582 SRCREV_pn-blktrace = "d6918c8832793b4205ed3bfede78c2f915c23385"
579 SRCREV_pn-opkg = "649" 583 SRCREV_pn-opkg = "649"
580 </literallayout> 584 </literallayout>
581 Some notes on using the <filename>buildhistory-collect-srcrevs</filename> 585 <note>
582 command: 586 Here are some notes on using the
583 <itemizedlist> 587 <filename>buildhistory-collect-srcrevs</filename> command:
584 <listitem><para>By default only values where the SRCREV was 588 <itemizedlist>
585 not hardcoded (usually when AUTOREV was used) are reported 589 <listitem><para>By default, only values where the
586 - use the <filename>-a</filename> option to see all SRCREV 590 <filename>SRCREV</filename> was
587 values.</para></listitem> 591 not hardcoded (usually when <filename>AUTOREV</filename>
588 <listitem><para>The output statements may not have any effect 592 was used) are reported.
589 in the face of overrides applied elsewhere in the build system 593 Use the <filename>-a</filename> option to see all
590 configuration; use the <filename>-f</filename> option to add the 594 <filename>SRCREV</filename> values.
591 <filename>forcevariable</filename> override to each output line 595 </para></listitem>
592 if you need to work around this.</para></listitem> 596 <listitem><para>The output statements might not have any effect
593 <listitem><para>The script does not do any special handling for 597 if overrides are applied elsewhere in the build system
594 building for multiple machines; however it does place a 598 configuration.
595 comment before each set of values specifying which triplet 599 Use the <filename>-f</filename> option to add the
596 (for example <filename>emenlow-poky-linux</filename>) that they 600 <filename>forcevariable</filename> override to each output line
597 belong to as shown above.</para></listitem> 601 if you need to work around this restriction.
598 </itemizedlist> 602 </para></listitem>
603 <listitem><para>The script does apply special handling when
604 building for multiple machines.
605 However, the script does place a
606 comment before each set of values that specifies
607 which triplet to which they belong as shown above
608 (e.g., <filename>emenlow-poky-linux</filename>).
609 </para></listitem>
610 </itemizedlist>
611 </note>
599 </para> 612 </para>
600 </section> 613 </section>
601 614