bitbake: 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>
(Bitbake rev: a3a3331e7118fd3139fe5a80b157a5a5b38631de)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

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 858054f..f5031cf 100644 (file)
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/bitbake/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>