aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-05-19 14:49:56 +0300
committerScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-18 12:04:03 +0300
commita3a3331e7118fd3139fe5a80b157a5a5b38631de (patch)
tree4860a25680c3b0089651f10b68f4d011b87adfd6 /doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
parent10988bd77c8c7cefad3b88744bc5d8a7e3c1f4cf (diff)
downloadbitbake-contrib-a3a3331e7118fd3139fe5a80b157a5a5b38631de.tar.gz
bitbake-user-manual-fetching.xml: Added new Git Submodule Fetcher section.
Added the "GIT Submodule Fetcher (gitsm://)" section to the fetchers chapter. This information was provided by Chris Morgan. Reported-by: Chris Morgan <chmorgan@gmail.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'doc/bitbake-user-manual/bitbake-user-manual-fetching.xml')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-fetching.xml27
1 files changed, 21 insertions, 6 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
index 858054f2f..f5031cfba 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -574,12 +574,27 @@
<title>GIT Submodule Fetcher (<filename>gitsm://</filename>)</title>
<para>
- This fetcher inherits from the Git fetcher and extends its
- behavior by fetching a repositories submodules.
- Uri is passed to the Git fetcher so see <link linkend='git-fetcher'>
- the git fetcher documentation for syntax</link>.
- NOTE: You must clean a recipe when switching between 'git://' and
- 'gitsm://' urls.
+ This fetcher submodule inherits from the
+ <link linkend='git-fetcher'>Git fetcher</link> and extends
+ that fetcher's behavior by fetching a repository's submodules.
+ URI is passed to the Git fetcher as described in the
+ "<link linkend='git-fetcher'>GIT Fetcher (<filename>git://</filename>)</link>"
+ section.
+ <note>
+ <title>Notes and Warnings</title>
+ <para>
+ You must clean a recipe when switching between
+ '<filename>git://</filename>' and
+ '<filename>gitsm://</filename>' URLs.
+ </para>
+
+ <para>
+ The Git Submodules fetcher is not a complete fetcher
+ implementation.
+ The fetcher has known issues where it does not use the
+ normal source mirroring infrastructure properly.
+ </para>
+ </note>
</para>
</section>