Kernel recipe naming

Kernel recipe naming

[Darren Hart]

I asked Richard about recipe naming convention this morning. We were pressed for
time, but this is what I took away from the discussion.

For typical packages, the filename typically looks like:

package-name_version.bb

For kernels this gets a bit more complex as it's useful to indicate the source
of the kernel (linaro, omap, etc.) as well as the base kernel version (2.6.33)
and Richard feels it would be nice to indicate in the filename what the
underlying source repository is (_git). (I agree up to the last point, but for
the source repository type, it seems to me if a user needs that much detail
they can open the .bb file and check the SRC_URI.)

So for a linux recipe, naming as follows seems to meet the above:

linux-linaro_2.6.35+git.bb
linux-linaro_2.6.37+git.bb

I mentioned the -stable and -devel tags which he agreed could be useful, how to
integrate them into the naming scheme wasn't clear to me though. Perhaps:

linux-linaro-stable_2.6.35+git.bb
linux-linaro-devel_2.6.37+git.bb

Although to me, stable and 2.6.35 are redundant for this kernel, and something
along the lines of the following is just as informative, and doesn't pollute the
directory listings quite as much (and doesn't have to be renamed when stable
rebases):

linux-linaro_stable.bb
linux-linaro_devel.bb

In any of the above cases, the PV value doesn't seem to be disputed:

PV=2.6.35+git${SRCPV}

or possibly

PV=2.6.35-linaro+git${SRCPV}

Although including linaro in the PV is probably redundant as it's included in
the PN and those are typically reported together IIRC $PN_$PV.

Thoughts?
-- 
Darren Hart
Yocto Linux Kernel

Re: Kernel recipe naming

[Frans Meulenbroeks]

2010/12/9 Darren Hart <dvhart@linux.intel.com>:
> I asked Richard about recipe naming convention this morning. We were pressed for
> time, but this is what I took away from the discussion.
>
> For typical packages, the filename typically looks like:
>
> package-name_version.bb

For perl cpan recipes the policy in OE is:
if the package is called X::Y the recipe name becomes
libX-Y-perl_version.bb

poky has only a few perl cpan packages but they seem to follow the same pattern.
In any case I feel it is quite desirable that they have perl in the
name, so they are easily identifiable as such.

Frans

Re: Kernel recipe naming

[Richard Purdie]

On Thu, 2010-12-09 at 10:33 -0800, Darren Hart wrote:
> I asked Richard about recipe naming convention this morning. We were pressed for
> time, but this is what I took away from the discussion.
> 
> For typical packages, the filename typically looks like:
> 
> package-name_version.bb
> 
> For kernels this gets a bit more complex as it's useful to indicate the source
> of the kernel (linaro, omap, etc.) as well as the base kernel version (2.6.33)
> and Richard feels it would be nice to indicate in the filename what the
> underlying source repository is (_git). (I agree up to the last point, but for
> the source repository type, it seems to me if a user needs that much detail
> they can open the .bb file and check the SRC_URI.)
> 
> So for a linux recipe, naming as follows seems to meet the above:
> 
> linux-linaro_2.6.35+git.bb
> linux-linaro_2.6.37+git.bb

So far so good :)

> I mentioned the -stable and -devel tags which he agreed could be useful, how to
> integrate them into the naming scheme wasn't clear to me though. Perhaps:
> 
> linux-linaro-stable_2.6.35+git.bb
> linux-linaro-devel_2.6.37+git.bb

No, PN should remain the same for things that are the same target. So
this should really be:

linux-linaro-2.6.35+git-stable.bb
linux-linaro_2.6.37+git-devel.bb

> Although to me, stable and 2.6.35 are redundant for this kernel, and something
> along the lines of the following is just as informative, and doesn't pollute the
> directory listings quite as much (and doesn't have to be renamed when stable
> rebases):
> 
> linux-linaro_stable.bb
> linux-linaro_devel.bb

This would be equally fine as long as you never expect to have two
versions. Since PV overrides whats in there that part of the string is
just for the user's reference and is quite open to various uses.

> In any of the above cases, the PV value doesn't seem to be disputed:
> 
> PV=2.6.35+git${SRCPV}
> 
> or possibly
> 
> PV=2.6.35-linaro+git${SRCPV}
>
> Although including linaro in the PV is probably redundant as it's included in
> the PN and those are typically reported together IIRC $PN_$PV.
>
> Thoughts?

This latter one is redundant as PN reflects it.

Note that there are some issues with the fetcher that mean linux-yocto
may break these guidelines for a short while. We're planning to fix the
fetcher.

Cheers,

Richard