docs on git fetcher don't match actual code

docs on git fetcher don't match actual code

[Robert P. J. Day]

[-- Attachment #1: Type: TEXT/PLAIN, Size: 1339 bytes --]


  perusing the bitbake user manual earlier and the section on the git
fetch module doesn't sync up with the code.  from the user manual:

"The parameters are tag, protocol and scmdata. tag is a Git tag, the
default is ‘master’. protocol is the Git protocol to use and defaults
to ‘rsync’."

  however, in fetch2/git.py, one reads:

- protocol
   The method to use to access the repository. Common options are
   "git", "http", "file" and "rsync". The default is "git"


  and, finally, further down, there's the actual check for a valid
protocol:

    if not ud.proto in ('git', 'file', 'ssh', 'http', 'https'):
        raise bb.fetch2.ParameterError("Invalid protocol type", ud.url)

which says nothing about "rsync" but lists "https" as a valid protocol
that's not mentioned higher up.  someone way higher up the food chain
is welcome to decide what should be clarified here.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

Re: docs on git fetcher don't match actual code

[Holger Hans Peter Freyther]

On 08/19/2011 07:11 PM, Robert P. J. Day wrote:
> 

> 
> which says nothing about "rsync" but lists "https" as a valid protocol
> that's not mentioned higher up.  someone way higher up the food chain
> is welcome to decide what should be clarified here.

Hi Robert,

I would update the manual to mention that 'git' is the default and remove
rsync from it. The reasoning is that rsync is mostly historic and there is no
good reason to use it.

holger

Re: docs on git fetcher don't match actual code

[Holger Freyther]

On 08/19/2011 07:11 PM, Robert P. J. Day wrote:
> 

> 
> which says nothing about "rsync" but lists "https" as a valid protocol
> that's not mentioned higher up.  someone way higher up the food chain
> is welcome to decide what should be clarified here.

Hi Robert,

I would update the manual to mention that 'git' is the default and remove
rsync from it. The reasoning is that rsync is mostly historic and there is no
good reason to use it.

holger

Re: docs on git fetcher don't match actual code

[Richard Purdie]

On Fri, 2011-08-19 at 13:11 -0400, Robert P. J. Day wrote:
> perusing the bitbake user manual earlier and the section on the git
> fetch module doesn't sync up with the code.  from the user manual:
> 
> "The parameters are tag, protocol and scmdata. tag is a Git tag, the
> default is ‘master’. protocol is the Git protocol to use and defaults
> to ‘rsync’."
> 
>   however, in fetch2/git.py, one reads:
> 
> - protocol
>    The method to use to access the repository. Common options are
>    "git", "http", "file" and "rsync". The default is "git"
> 
> 
>   and, finally, further down, there's the actual check for a valid
> protocol:
> 
>     if not ud.proto in ('git', 'file', 'ssh', 'http', 'https'):
>         raise bb.fetch2.ParameterError("Invalid protocol type", ud.url)
> 
> which says nothing about "rsync" but lists "https" as a valid protocol
> that's not mentioned higher up.  someone way higher up the food chain
> is welcome to decide what should be clarified here.

Thanks, I've pushed a couple of commits which should clarify the
situation.

Cheers,

Richard