Design Document of "Yocto 1656 Recipe creation/import script"

Design Document of "Yocto 1656 Recipe creation/import script"

[Kang Kai]

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

Hi All,

This is the design document of "Yocto 1656 Recipe creation/import 
script". Please help to review it.
Any suggestion is appreciate.

Regards,
Kai

[-- Attachment #2: recipe_creation_bb.txt --]
[-- Type: text/plain, Size: 906 bytes --]

    Design documnet for Recipe creation/import script

* Purpose

The feature is from Yocto 1.2 Bug 1656. A script or similar system
that would allow you to give is an upstream URL, tarball, patch set,
package (SRPM, or debian style) and generate a recipe based on those
instructions. 

Name it with bitbake-createbb, and integrate into the build system
to use the build system infrastructure that similiar with bitbake-runtask.

* Usage:
bitbake-createbb <SRC_URI> [PATCH_SRC_URI]

* Steps
1 download the source package frowm the SRC_RUI
2 get package name and version from package or tarball name. 
3 get summary and description from SRPM spec file or debian control file, or from configure files. 
4 get license and license checksum. 
5 get dependent packages
  |-- just parse spec file or debian control file
  |-- or get them by parse configure files
6 remove downloaded files

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Andreas Müller]

On Friday, January 06, 2012 10:51:57 AM Kang Kai wrote:
> Hi All,
> 
> This is the design document of "Yocto 1656 Recipe creation/import
> script". Please help to review it.
> Any suggestion is appreciate.
> 
> Regards,
> Kai

* s/documnet/document
* s/SRC_RUI/SRC_URI
* reading first time, I thought 'Steps' mean things user has to perform

A bit off-topic: Where is the location for these kind of documents?

Andreas

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Pedro Algarvio]

Is there any work started regarding this?
Will this be part of bitbake?
Python will be it's "implementation" language?

Best Regards,
Pedro Algarvio.


On 06/01/12 09:51, Kang Kai wrote:
> Hi All,
> 
> This is the design document of "Yocto 1656 Recipe creation/import
> script". Please help to review it.
> Any suggestion is appreciate.
> 
> Regards,
> Kai
> 
> 
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Joshua Lock]

Hi Kai,

On 06/01/12 01:51, Kang Kai wrote:
> This is the design document of "Yocto 1656 Recipe creation/import
> script". Please help to review it.
> Any suggestion is appreciate.

You should check out autospectacle[1] that I linked to in the bug 
report. It does a lot of guessing using clever tricks like searching 
Freshmeat, doap files, READMES etc to get a description[2] and analysing 
configure.ac[3], qmake[4], etc. to determine dependencies.

The autospectacle perl script is reasonably well commented and quite 
readable.

I'm not suggesting we adopt all of the features in it but many of them 
are useful techniques for this effort.

Regards,
Joshua

1. https://meego.gitorious.org/meego-developer-tools/autospectacle/
2. 
https://meego.gitorious.org/meego-developer-tools/autospectacle/blobs/master/autospectacle.pl#line1001
3. 
https://meego.gitorious.org/meego-developer-tools/autospectacle/blobs/master/autospectacle.pl#line633
4. 
https://meego.gitorious.org/meego-developer-tools/autospectacle/blobs/master/autospectacle.pl#line840
-- 
Joshua Lock
         Yocto Project "Johannes factotum"
         Intel Open Source Technology Centre

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Kang Kai]

On 2012年01月06日 22:18, Andreas Müller wrote:
> On Friday, January 06, 2012 10:51:57 AM Kang Kai wrote:
>> Hi All,
>>
>> This is the design document of "Yocto 1656 Recipe creation/import
>> script". Please help to review it.
>> Any suggestion is appreciate.
>>
>> Regards,
>> Kai

Hi Andreas,

> * s/documnet/document
> * s/SRC_RUI/SRC_URI
> * reading first time, I thought 'Steps' mean things user has to perform
Thanks. I will update them.

>
> A bit off-topic: Where is the location for these kind of documents?
Do you mean design document? We(WindRiver guys) write it then send it to 
the mailist.

Regards,
Kai

>
> Andreas
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Kang Kai]

On 2012年01月06日 22:35, Pedro Algarvio wrote:

Hi Pedro,

> Is there any work started regarding this?
There is perl script from meego do the similar thing.

> Will this be part of bitbake?
I want to put it under directory "scripts"

> Python will be it's "implementation" language?
Yes.

Regards,
Kai
>
> Best Regards,
> Pedro Algarvio.
>
>
> On 06/01/12 09:51, Kang Kai wrote:
>> Hi All,
>>
>> This is the design document of "Yocto 1656 Recipe creation/import
>> script". Please help to review it.
>> Any suggestion is appreciate.
>>
>> Regards,
>> Kai
>>
>>
>> _______________________________________________
>> yocto mailing list
>> yocto@yoctoproject.org
>> https://lists.yoctoproject.org/listinfo/yocto
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Kang Kai]

On 2012年01月07日 03:18, Joshua Lock wrote:

Hi Joshua,

> Hi Kai,
>
> On 06/01/12 01:51, Kang Kai wrote:
>> This is the design document of "Yocto 1656 Recipe creation/import
>> script". Please help to review it.
>> Any suggestion is appreciate.
>
> You should check out autospectacle[1] that I linked to in the bug 
> report. It does a lot of guessing using clever tricks like searching 
> Freshmeat, doap files, READMES etc to get a description[2] and 
> analysing configure.ac[3], qmake[4], etc. to determine dependencies.

Thanks for your reply.
I have checked out and read the autospectacle, and show me the direction.
Right now I want to get the NAME, description, license and checksum, 
depends and some simple inheritance, do you think that is enough for 
this feature? If not, what's more?

Thanks & Regards,
Kai

>
> The autospectacle perl script is reasonably well commented and quite 
> readable.
>
> I'm not suggesting we adopt all of the features in it but many of them 
> are useful techniques for this effort.
>
> Regards,
> Joshua
>
> 1. https://meego.gitorious.org/meego-developer-tools/autospectacle/
> 2. 
> https://meego.gitorious.org/meego-developer-tools/autospectacle/blobs/master/autospectacle.pl#line1001
> 3. 
> https://meego.gitorious.org/meego-developer-tools/autospectacle/blobs/master/autospectacle.pl#line633
> 4. 
> https://meego.gitorious.org/meego-developer-tools/autospectacle/blobs/master/autospectacle.pl#line840

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Kang Kai]

On 2012年01月09日 11:30, Kang Kai wrote:
> On 2012年01月06日 22:35, Pedro Algarvio wrote:
>
> Hi Pedro,
>
>> Is there any work started regarding this?
> There is perl script from meego do the similar thing.
>
>> Will this be part of bitbake?
> I want to put it under directory "scripts"
My mistake, put it under "bitbake/bin"

>
>> Python will be it's "implementation" language?
> Yes.
>
> Regards,
> Kai
>>
>> Best Regards,
>> Pedro Algarvio.
>>
>>
>> On 06/01/12 09:51, Kang Kai wrote:
>>> Hi All,
>>>
>>> This is the design document of "Yocto 1656 Recipe creation/import
>>> script". Please help to review it.
>>> Any suggestion is appreciate.
>>>
>>> Regards,
>>> Kai
>>>
>>>
>>> _______________________________________________
>>> yocto mailing list
>>> yocto@yoctoproject.org
>>> https://lists.yoctoproject.org/listinfo/yocto
>> _______________________________________________
>> yocto mailing list
>> yocto@yoctoproject.org
>> https://lists.yoctoproject.org/listinfo/yocto
>
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto

Re: Design Document of "Yocto 1656 Recipe creation/import script"

[Joshua Lock]

On 08/01/12 21:49, Kang Kai wrote:
> On 2012年01月07日 03:18, Joshua Lock wrote:
>
> Hi Joshua,
>
>> Hi Kai,
>>
>> On 06/01/12 01:51, Kang Kai wrote:
>>> This is the design document of "Yocto 1656 Recipe creation/import
>>> script". Please help to review it.
>>> Any suggestion is appreciate.
>>
>> You should check out autospectacle[1] that I linked to in the bug
>> report. It does a lot of guessing using clever tricks like searching
>> Freshmeat, doap files, READMES etc to get a description[2] and
>> analysing configure.ac[3], qmake[4], etc. to determine dependencies.
>
> Thanks for your reply.
> I have checked out and read the autospectacle, and show me the direction.
> Right now I want to get the NAME, description, license and checksum,
> depends and some simple inheritance, do you think that is enough for
> this feature? If not, what's more?

I think that would be a very good start, yes.

Thanks,
Joshua
-- 
Joshua Lock
         Yocto Project "Johannes factotum"
         Intel Open Source Technology Centre