[PATCH] Documentation improvements for gitsm:// fetcher

[PATCH] Documentation improvements for gitsm:// fetcher

[Chris Morgan]

[-- Attachment #1: Type: text/plain, Size: 176 bytes --]

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

[-- Attachment #2: 0001-Documentation-improvements-for-gitsm-fetcher.patch --]
[-- Type: text/x-patch, Size: 2644 bytes --]

From 79708d5226c2c0771aecd1b8797c24ee5301b3c6 Mon Sep 17 00:00:00 2001
From: Chris Morgan <chmorgan@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

Re: [PATCH] Documentation improvements for gitsm:// fetcher

[Rifenbark, Scott M]

Hi, 

This patch is not coming across to me intact.  The process I use for patches is to take the attachment from my Thunderbird account and save it as an .EML file.  Then, I mail that .EML file to my Linux box gmail account.  From there I process the patch using the 'patch' command as normal.  For some reason, the .EML file when it arrives to my gmail account has long lines of random characters (gibberish) that the patch program is unable to deal with.  I am unsure if it is a problem on my end with my process or with the patch generation. 

Scott

>-----Original Message-----
>From: yocto-bounces@yoctoproject.org [mailto:yocto-
>bounces@yoctoproject.org] On Behalf Of Chris Morgan
>Sent: Sunday, May 18, 2014 11:29 AM
>To: yocto@yoctoproject.org
>Subject: [yocto] [PATCH] Documentation improvements for gitsm:// fetcher
>
>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

Re: [PATCH] Documentation improvements for gitsm:// fetcher

[Rifenbark, Scott M]

I can't apply this patch.  It goes beyond the doc files so I need to leave it to Richard to apply.

Scott

>-----Original Message-----
>From: yocto-bounces@yoctoproject.org [mailto:yocto-
>bounces@yoctoproject.org] On Behalf Of Rifenbark, Scott M
>Sent: Sunday, May 18, 2014 10:34 PM
>To: Chris Morgan; yocto@yoctoproject.org
>Subject: Re: [yocto] [PATCH] Documentation improvements for gitsm://
>fetcher
>
>Hi,
>
>This patch is not coming across to me intact.  The process I use for patches is to
>take the attachment from my Thunderbird account and save it as an .EML file.
>Then, I mail that .EML file to my Linux box gmail account.  From there I process
>the patch using the 'patch' command as normal.  For some reason, the .EML
>file when it arrives to my gmail account has long lines of random characters
>(gibberish) that the patch program is unable to deal with.  I am unsure if it is a
>problem on my end with my process or with the patch generation.
>
>Scott
>
>>-----Original Message-----
>>From: yocto-bounces@yoctoproject.org [mailto:yocto-
>>bounces@yoctoproject.org] On Behalf Of Chris Morgan
>>Sent: Sunday, May 18, 2014 11:29 AM
>>To: yocto@yoctoproject.org
>>Subject: [yocto] [PATCH] Documentation improvements for gitsm://
>>fetcher
>>
>>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
>--
>_______________________________________________
>yocto mailing list
>yocto@yoctoproject.org
>https://lists.yoctoproject.org/listinfo/yocto

Re: [PATCH] Documentation improvements for gitsm:// fetcher

[Chris Morgan]

On Mon, May 19, 2014 at 1:34 AM, Rifenbark, Scott M
<scott.m.rifenbark@intel.com> wrote:
> Hi,
>
> This patch is not coming across to me intact.  The process I use for patches is to take the attachment from my Thunderbird account and save it as an .EML file.  Then, I mail that .EML file to my Linux box gmail account.  From there I process the patch using the 'patch' command as normal.  For some reason, the .EML file when it arrives to my gmail account has long lines of random characters (gibberish) that the patch program is unable to deal with.  I am unsure if it is a problem on my end with my process or with the patch generation.
>
> Scott
>
>>-----Original Message-----
>>From: yocto-bounces@yoctoproject.org [mailto:yocto-
>>bounces@yoctoproject.org] On Behalf Of Chris Morgan
>>Sent: Sunday, May 18, 2014 11:29 AM
>>To: yocto@yoctoproject.org
>>Subject: [yocto] [PATCH] Documentation improvements for gitsm:// fetcher
>>
>>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


I'm not sure what might be doing on. I'm adding it to the email
directly from the gmail web interface from the file created via 'git
format-patch -1'. I looked but don't see any email settings around
mime in gmail's settings. Should I not be sending via email? Am I
missing a setting?

Chris

Re: [PATCH] Documentation improvements for gitsm:// fetcher

[Richard Purdie]

On Mon, 2014-05-19 at 06:42 -0400, Chris Morgan wrote:
> On Mon, May 19, 2014 at 1:34 AM, Rifenbark, Scott M
> <scott.m.rifenbark@intel.com> wrote:
> > Hi,
> >
> > This patch is not coming across to me intact.  The process I use for patches is to take the attachment from my Thunderbird account and save it as an .EML file.  Then, I mail that .EML file to my Linux box gmail account.  From there I process the patch using the 'patch' command as normal.  For some reason, the .EML file when it arrives to my gmail account has long lines of random characters (gibberish) that the patch program is unable to deal with.  I am unsure if it is a problem on my end with my process or with the patch generation.
> >
> > Scott
> >
> >>-----Original Message-----
> >>From: yocto-bounces@yoctoproject.org [mailto:yocto-
> >>bounces@yoctoproject.org] On Behalf Of Chris Morgan
> >>Sent: Sunday, May 18, 2014 11:29 AM
> >>To: yocto@yoctoproject.org
> >>Subject: [yocto] [PATCH] Documentation improvements for gitsm:// fetcher
> >>
> >>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
> 
> 
> I'm not sure what might be doing on. I'm adding it to the email
> directly from the gmail web interface from the file created via 'git
> format-patch -1'. I looked but don't see any email settings around
> mime in gmail's settings. Should I not be sending via email? Am I
> missing a setting?

Things were a little confusing for Scott since the patch is against
poky, not the bitbake repository. I've merged in the patch, thanks.

In future please include a Signed-off-by line and with the shortlog in
the commit message, format it as per the contribution guidelines so that
someone can easily see which code it affects (fetch2/gitsm: is
appropriate in this case).

Cheers,

Richard