summaryrefslogtreecommitdiffstats
path: root/bitbake
diff options
context:
space:
mode:
authorNicolas Cornu <nicolac76@yahoo.fr>2018-02-09 08:42:07 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:26:03 +0000
commitf16d8be9ab97f1d819da45716efa05dfc50088e9 (patch)
tree74bffabb462a95afa3a3846c5aa764386dedf018 /bitbake
parent931f57080f5ec0912afa93fbda992d772724a2f8 (diff)
downloadpoky-f16d8be9ab97f1d819da45716efa05dfc50088e9.tar.gz
bitbake: bitbake-user-manual: Added google-repo fetcher and REPODIR var.
Added a new repo 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 REPODIR. (Bitbake rev: 1cf084cee506574b7bb6ed03344597b3b2f2fe08) Signed-off-by: Nicolas Cornu <nicolac76@yahoo.fr> Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml40
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml10
2 files changed, 47 insertions, 3 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 c721e86eb9..29ae486a7c 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -777,6 +777,43 @@
777 </para> 777 </para>
778 </section> 778 </section>
779 779
780 <section id='repo-fetcher'>
781 <title>Repo Fetcher (<filename>repo://</filename>)</title>
782
783 <para>
784 This fetcher submodule fetches code from
785 <filename>google-repo</filename> source control system.
786 The fetcher works by initiating and syncing sources of the
787 repository into
788 <link linkend='var-REPODIR'><filename>REPODIR</filename></link>,
789 which is usually
790 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link><filename>/repo</filename>.
791 </para>
792
793 <para>
794 This fetcher supports the following parameters:
795 <itemizedlist>
796 <listitem><para>
797 <emphasis>"protocol":</emphasis>
798 Protocol to fetch the repository manifest (default: git).
799 </para></listitem>
800 <listitem><para>
801 <emphasis>"branch":</emphasis>
802 Branch or tag of repository to get (default: master).
803 </para></listitem>
804 <listitem><para>
805 <emphasis>"manifest":</emphasis>
806 Name of the manifest file (default: <filename>default.xml</filename>).
807 </para></listitem>
808 </itemizedlist>
809 Here are some example URLs:
810 <literallayout class='monospaced'>
811 SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml"
812 SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml"
813 </literallayout>
814 </para>
815 </section>
816
780 <section id='other-fetchers'> 817 <section id='other-fetchers'>
781 <title>Other Fetchers</title> 818 <title>Other Fetchers</title>
782 819
@@ -796,9 +833,6 @@
796 Secure Shell (<filename>ssh://</filename>) 833 Secure Shell (<filename>ssh://</filename>)
797 </para></listitem> 834 </para></listitem>
798 <listitem><para> 835 <listitem><para>
799 Repo (<filename>repo://</filename>)
800 </para></listitem>
801 <listitem><para>
802 OSC (<filename>osc://</filename>) 836 OSC (<filename>osc://</filename>)
803 </para></listitem> 837 </para></listitem>
804 <listitem><para> 838 <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 d89e123e06..cee6c94753 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
@@ -2089,6 +2089,16 @@
2089 </glossdef> 2089 </glossdef>
2090 </glossentry> 2090 </glossentry>
2091 2091
2092 <glossentry id='var-REPODIR'><glossterm>REPODIR</glossterm>
2093 <glossdef>
2094 <para>
2095 The directory in which a local copy of a
2096 <filename>google-repo</filename> directory is stored
2097 when it is synced.
2098 </para>
2099 </glossdef>
2100 </glossentry>
2101
2092 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm> 2102 <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm>
2093 <glossdef> 2103 <glossdef>
2094 <para> 2104 <para>