summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorAndrew Bradford <andrew.bradford@kodakalaris.com>2016-07-14 11:42:56 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-07-21 07:47:53 +0100
commit35081f55185a8a9804c21b16cd4600ba70646a10 (patch)
tree075473551c71b26e8f72b6199b5a1fa4a9bc760a /bitbake/doc
parenta6cffcffc17eb86ee8870ecec2d836d786dc3231 (diff)
downloadpoky-35081f55185a8a9804c21b16cd4600ba70646a10.tar.gz
bitbake: bitbake-user-manual: Addeds support for the Perforce Fetcher
Added a new Perforce Fetcher section in the same spirit as the existing sections for other supported fetchers. Changes included the new section, removal of the bulleted item that mentioned this fetcher as an "additional" fetcher, and the creation of a new variable in the glossary named P4DIR. (Bitbake rev: 47e03b1789ee1c18407dbac33a6c235752019865) 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-fetching.xml69
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml11
2 files changed, 74 insertions, 6 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
index f168cfa686..2a3340b399 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -670,8 +670,8 @@
670 The <filename>module</filename> and <filename>vob</filename> 670 The <filename>module</filename> and <filename>vob</filename>
671 options are combined to create the <filename>load</filename> rule in 671 options are combined to create the <filename>load</filename> rule in
672 the view config spec. 672 the view config spec.
673 As an example, consider the <filename>vob</filename> and 673 As an example, consider the <filename>vob</filename> and
674 <filename>module</filename> values from the 674 <filename>module</filename> values from the
675 <filename>SRC_URI</filename> statement at the start of this section. 675 <filename>SRC_URI</filename> statement at the start of this section.
676 Combining those values results in the following: 676 Combining those values results in the following:
677 <literallayout class='monospaced'> 677 <literallayout class='monospaced'>
@@ -716,6 +716,68 @@
716 </para> 716 </para>
717 </section> 717 </section>
718 718
719 <section id='perforce-fetcher'>
720 <title>Perforce Fetcher (<filename>p4://</filename>)</title>
721
722 <para>
723 This fetcher submodule fetches code from the
724 <ulink url='https://www.perforce.com/'>Perforce</ulink>
725 source control system.
726 The executable used is specified by
727 <filename>FETCHCMD_p4</filename>, which defaults
728 to "p4".
729 The fetcher's temporary working directory is set by
730 <link linkend='var-P4DIR'><filename>P4DIR</filename></link>,
731 which defaults to "DL_DIR/p4".
732 </para>
733
734 <para>
735 To use this fetcher, make sure your recipe has proper
736 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>,
737 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>, and
738 <link linkend='var-PV'><filename>PV</filename></link> values.
739 The p4 executable is able to use the config file defined by your
740 system's <filename>P4CONFIG</filename> environment variable in
741 order to define the Perforce server URL and port, username, and
742 password if you do not wish to keep those values in a recipe
743 itself.
744 If you choose not to use <filename>P4CONFIG</filename>,
745 or to explicitly set variables that <filename>P4CONFIG</filename>
746 can contain, you can specify the <filename>P4PORT</filename> value,
747 which is the server's URL and port number, and you can
748 specify a username and password directly in your recipe within
749 <filename>SRC_URI</filename>.
750 </para>
751
752 <para>
753 Here is an example that relies on <filename>P4CONFIG</filename>
754 to specify the server URL and port, username, and password, and
755 fetches the Head Revision:
756 <literallayout class='monospaced'>
757 SRC_URI = "p4://example-depot/main/source/..."
758 SRCREV = "${AUTOREV}"
759 PV = "p4-${SRCPV}"
760 S = "${WORKDIR}/p4"
761 </literallayout>
762 </para>
763
764 <para>
765 Here is an example that specifies the server URL and port,
766 username, and password, and fetches a Revision based on a Label:
767 <literallayout class='monospaced'>
768 P4PORT = "tcp:p4server.example.net:1666"
769 SRC_URI = "p4://user:passwd@example-depot/main/source/..."
770 SRCREV = "release-1.0"
771 PV = "p4-${SRCPV}"
772 S = "${WORKDIR}/p4"
773 </literallayout>
774 <note>
775 You should always set <filename>S</filename>
776 to <filename>"${WORKDIR}/p4"</filename> in your recipe.
777 </note>
778 </para>
779 </section>
780
719 <section id='other-fetchers'> 781 <section id='other-fetchers'>
720 <title>Other Fetchers</title> 782 <title>Other Fetchers</title>
721 783
@@ -726,9 +788,6 @@
726 Bazaar (<filename>bzr://</filename>) 788 Bazaar (<filename>bzr://</filename>)
727 </para></listitem> 789 </para></listitem>
728 <listitem><para> 790 <listitem><para>
729 Perforce (<filename>p4://</filename>)
730 </para></listitem>
731 <listitem><para>
732 Trees using Git Annex (<filename>gitannex://</filename>) 791 Trees using Git Annex (<filename>gitannex://</filename>)
733 </para></listitem> 792 </para></listitem>
734 <listitem><para> 793 <listitem><para>
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index e26422a421..e81f3ed653 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
@@ -52,7 +52,7 @@
52 <link linkend='var-MIRRORS'>M</link> 52 <link linkend='var-MIRRORS'>M</link>
53<!-- <link linkend='var-glossary-n'>N</link> --> 53<!-- <link linkend='var-glossary-n'>N</link> -->
54 <link linkend='var-OVERRIDES'>O</link> 54 <link linkend='var-OVERRIDES'>O</link>
55 <link linkend='var-PACKAGES'>P</link> 55 <link linkend='var-P4DIR'>P</link>
56<!-- <link linkend='var-QMAKE_PROFILES'>Q</link> --> 56<!-- <link linkend='var-QMAKE_PROFILES'>Q</link> -->
57 <link linkend='var-RDEPENDS'>R</link> 57 <link linkend='var-RDEPENDS'>R</link>
58 <link linkend='var-SECTION'>S</link> 58 <link linkend='var-SECTION'>S</link>
@@ -1769,6 +1769,15 @@
1769 1769
1770 <glossdiv id='var-glossary-p'><title>P</title> 1770 <glossdiv id='var-glossary-p'><title>P</title>
1771 1771
1772 <glossentry id='var-P4DIR'><glossterm>P4DIR</glossterm>
1773 <glossdef>
1774 <para>
1775 The directory in which a local copy of a Perforce depot
1776 is stored when it is fetched.
1777 </para>
1778 </glossdef>
1779 </glossentry>
1780
1772 <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> 1781 <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
1773 <glossdef> 1782 <glossdef>
1774 <para>The list of packages the recipe creates. 1783 <para>The list of packages the recipe creates.