Rough patch for documentation improvements now that I know how gitsm
should work and to help others that might be caught by switching from
git:// to gitsm:// URIs.
Chris
From 79708d5226c2c0771aecd1b8797c24ee5301b3c6 Mon Sep 17 00:00:00 2001
From: Chris Morgan <chmor...@gmail.com>
Date: Sun, 18 May 2014 14:24:12 -0400
Subject: [PATCH] Documentation improvements for gitsm:// fetcher
---
.../bitbake-user-manual/bitbake-user-manual-fetching.xml | 16 +++++++++++++---
bitbake/lib/bb/fetch2/gitsm.py | 10 ++++++++++
2 files changed, 23 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 5aa53de..858054f 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml
@@ -570,6 +570,19 @@
</para>
</section>
+ <section id='gitsm-fetcher'>
+ <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.
+ </para>
+ </section>
+
<section id='other-fetchers'>
<title>Other Fetchers</title>
@@ -583,9 +596,6 @@
Perforce (<filename>p4://</filename>)
</para></listitem>
<listitem><para>
- Git Submodules (<filename>gitsm://</filename>)
- </para></listitem>
- <listitem><para>
Trees using Git Annex (<filename>gitannex://</filename>)
</para></listitem>
<listitem><para>
diff --git a/bitbake/lib/bb/fetch2/gitsm.py b/bitbake/lib/bb/fetch2/gitsm.py
index 1a76215..c125cff 100644
--- a/bitbake/lib/bb/fetch2/gitsm.py
+++ b/bitbake/lib/bb/fetch2/gitsm.py
@@ -2,6 +2,16 @@
# -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
"""
BitBake 'Fetch' git submodules implementation
+
+Inherits from and extends the Git fetcher to retrieve submodules of a git repository
+after cloning.
+
+SRC_URI = "gitsm://<see Git fetcher for syntax>"
+
+See the Git fetcher, git://, for usage documentation.
+
+NOTE: Switching a SRC_URI from "git://" to "gitsm://" requires a clean of your recipe.
+
"""
# Copyright (C) 2013 Richard Purdie
--
1.9.0
--
_______________________________________________
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
