diff mbox series

[meta-ti,master/wrynose,v2] ti-linux-fw: Remove default SUMMARY line

Message ID 20260624203026.1155961-1-afd@ti.com
State New
Headers show
Series [meta-ti,master/wrynose,v2] ti-linux-fw: Remove default SUMMARY line | expand

Commit Message

Andrew Davis June 24, 2026, 8:30 p.m. UTC
All firmware that includes this helper should set their own SUMMARY line.
Currently all do (other than ti-adc-fw which we fix here), but they often
include this file after setting their own SUMMARY, so this common one
overwrites the correct one. Remove this default SUMMARY.

Signed-off-by: Andrew Davis <afd@ti.com>
---

Changes for v2:
 - Update ti-adc-fw so it has a SUMMARY

 meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb      | 2 +-
 meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc | 2 --
 2 files changed, 1 insertion(+), 3 deletions(-)

Comments

Denys Dmytriyenko June 24, 2026, 8:37 p.m. UTC | #1
On Wed, Jun 24, 2026 at 03:30:26PM -0500, Andrew Davis via lists.yoctoproject.org wrote:
> All firmware that includes this helper should set their own SUMMARY line.
> Currently all do (other than ti-adc-fw which we fix here), but they often
> include this file after setting their own SUMMARY, so this common one
> overwrites the correct one. Remove this default SUMMARY.

How about flipping it the other way around?

In the common .inc file we set:

SUMMARY = "Prebuild binary firmware"

And in specific firmware recioes we clarify:

SUMMARY .= " for TI ADC PCM6240 configuration"

That way it won't matter if the inclusion happens before or after setting the 
specific SUMMARY and it won't be completely empty (albeit generic) if someone 
forgets setting SUMMARY in the recipe.


> Signed-off-by: Andrew Davis <afd@ti.com>
> ---
> 
> Changes for v2:
>  - Update ti-adc-fw so it has a SUMMARY
> 
>  meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb      | 2 +-
>  meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc | 2 --
>  2 files changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
> index ad025483..0b70d69d 100644
> --- a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
> +++ b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
> @@ -1,4 +1,4 @@
> -DESCRIPTION = "TI ADC PCM6240 config prebuild binary firmware"
> +SUMMARY = "TI ADC PCM6240 config prebuild binary firmware"
>  
>  require recipes-bsp/ti-linux-fw/ti-linux-fw.inc
>  
> diff --git a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> index 126c46df..d343a6aa 100644
> --- a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> +++ b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> @@ -1,5 +1,3 @@
> -SUMMARY = "Common include for TI Linux firmware"
> -
>  LICENSE = "TI-TFL"
>  LIC_FILES_CHKSUM = "file://LICENSE.ti;md5=b5aebf0668bdf95621259288c4a46d76"
>  
> -- 
> 2.39.2
Andrew Davis June 24, 2026, 8:47 p.m. UTC | #2
On 6/24/26 3:37 PM, Denys Dmytriyenko wrote:
> On Wed, Jun 24, 2026 at 03:30:26PM -0500, Andrew Davis via lists.yoctoproject.org wrote:
>> All firmware that includes this helper should set their own SUMMARY line.
>> Currently all do (other than ti-adc-fw which we fix here), but they often
>> include this file after setting their own SUMMARY, so this common one
>> overwrites the correct one. Remove this default SUMMARY.
> 
> How about flipping it the other way around?
> 
> In the common .inc file we set:
> 
> SUMMARY = "Prebuild binary firmware"
> 
> And in specific firmware recioes we clarify:
> 
> SUMMARY .= " for TI ADC PCM6240 configuration"
> 
> That way it won't matter if the inclusion happens before or after setting the
> specific SUMMARY and it won't be completely empty (albeit generic) if someone
> forgets setting SUMMARY in the recipe.
> 

It might technically work, but I'd rather we throw a warning if someone forgets
their SUMMARY line rather than just taking a super generic fallback. If we allow
fallbacks like that what stops us from having

SUMMARY = "Yocto recipe"

in some main conf and hope recipes add

SUMMARY .= " for Linux kernel on TI devices"

Andrew

> 
>> Signed-off-by: Andrew Davis <afd@ti.com>
>> ---
>>
>> Changes for v2:
>>   - Update ti-adc-fw so it has a SUMMARY
>>
>>   meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb      | 2 +-
>>   meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc | 2 --
>>   2 files changed, 1 insertion(+), 3 deletions(-)
>>
>> diff --git a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
>> index ad025483..0b70d69d 100644
>> --- a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
>> +++ b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
>> @@ -1,4 +1,4 @@
>> -DESCRIPTION = "TI ADC PCM6240 config prebuild binary firmware"
>> +SUMMARY = "TI ADC PCM6240 config prebuild binary firmware"
>>   
>>   require recipes-bsp/ti-linux-fw/ti-linux-fw.inc
>>   
>> diff --git a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
>> index 126c46df..d343a6aa 100644
>> --- a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
>> +++ b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
>> @@ -1,5 +1,3 @@
>> -SUMMARY = "Common include for TI Linux firmware"
>> -
>>   LICENSE = "TI-TFL"
>>   LIC_FILES_CHKSUM = "file://LICENSE.ti;md5=b5aebf0668bdf95621259288c4a46d76"
>>   
>> -- 
>> 2.39.2
Denys Dmytriyenko June 24, 2026, 8:54 p.m. UTC | #3
On Wed, Jun 24, 2026 at 03:47:52PM -0500, Andrew Davis via lists.yoctoproject.org wrote:
> On 6/24/26 3:37 PM, Denys Dmytriyenko wrote:
> >On Wed, Jun 24, 2026 at 03:30:26PM -0500, Andrew Davis via lists.yoctoproject.org wrote:
> >>All firmware that includes this helper should set their own SUMMARY line.
> >>Currently all do (other than ti-adc-fw which we fix here), but they often
> >>include this file after setting their own SUMMARY, so this common one
> >>overwrites the correct one. Remove this default SUMMARY.
> >
> >How about flipping it the other way around?
> >
> >In the common .inc file we set:
> >
> >SUMMARY = "Prebuild binary firmware"
> >
> >And in specific firmware recioes we clarify:
> >
> >SUMMARY .= " for TI ADC PCM6240 configuration"
> >
> >That way it won't matter if the inclusion happens before or after setting the
> >specific SUMMARY and it won't be completely empty (albeit generic) if someone
> >forgets setting SUMMARY in the recipe.
> >
> 
> It might technically work, but I'd rather we throw a warning if someone forgets
> their SUMMARY line rather than just taking a super generic fallback. If we allow
> fallbacks like that what stops us from having
> 
> SUMMARY = "Yocto recipe"
> 
> in some main conf and hope recipes add
> 
> SUMMARY .= " for Linux kernel on TI devices"

There won't be any warning, as OE-Core has defaults for SUMMARY and 
DESCRIPTION:

https://git.openembedded.org/openembedded-core/tree/meta/conf/bitbake.conf#n276



> Andrew
> 
> >
> >>Signed-off-by: Andrew Davis <afd@ti.com>
> >>---
> >>
> >>Changes for v2:
> >>  - Update ti-adc-fw so it has a SUMMARY
> >>
> >>  meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb      | 2 +-
> >>  meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc | 2 --
> >>  2 files changed, 1 insertion(+), 3 deletions(-)
> >>
> >>diff --git a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
> >>index ad025483..0b70d69d 100644
> >>--- a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
> >>+++ b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
> >>@@ -1,4 +1,4 @@
> >>-DESCRIPTION = "TI ADC PCM6240 config prebuild binary firmware"
> >>+SUMMARY = "TI ADC PCM6240 config prebuild binary firmware"
> >>  require recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> >>diff --git a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> >>index 126c46df..d343a6aa 100644
> >>--- a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> >>+++ b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
> >>@@ -1,5 +1,3 @@
> >>-SUMMARY = "Common include for TI Linux firmware"
> >>-
> >>  LICENSE = "TI-TFL"
> >>  LIC_FILES_CHKSUM = "file://LICENSE.ti;md5=b5aebf0668bdf95621259288c4a46d76"
> >>-- 
> >>2.39.2
Robert P. J. Day June 24, 2026, 9 p.m. UTC | #4
On Wed, 24 Jun 2026, Denys Dmytriyenko wrote:

> On Wed, Jun 24, 2026 at 03:47:52PM -0500, Andrew Davis via lists.yoctoproject.org wrote:
> > On 6/24/26 3:37 PM, Denys Dmytriyenko wrote:
> > >On Wed, Jun 24, 2026 at 03:30:26PM -0500, Andrew Davis via lists.yoctoproject.org wrote:
> > >>All firmware that includes this helper should set their own SUMMARY line.
> > >>Currently all do (other than ti-adc-fw which we fix here), but they often
> > >>include this file after setting their own SUMMARY, so this common one
> > >>overwrites the correct one. Remove this default SUMMARY.
> > >
> > >How about flipping it the other way around?
> > >
> > >In the common .inc file we set:
> > >
> > >SUMMARY = "Prebuild binary firmware"
> > >
> > >And in specific firmware recioes we clarify:
> > >
> > >SUMMARY .= " for TI ADC PCM6240 configuration"
> > >
> > >That way it won't matter if the inclusion happens before or after setting the
> > >specific SUMMARY and it won't be completely empty (albeit generic) if someone
> > >forgets setting SUMMARY in the recipe.
> > >
> >
> > It might technically work, but I'd rather we throw a warning if someone forgets
> > their SUMMARY line rather than just taking a super generic fallback. If we allow
> > fallbacks like that what stops us from having
> >
> > SUMMARY = "Yocto recipe"
> >
> > in some main conf and hope recipes add
> >
> > SUMMARY .= " for Linux kernel on TI devices"
>
> There won't be any warning, as OE-Core has defaults for SUMMARY and
> DESCRIPTION:
>
> https://git.openembedded.org/openembedded-core/tree/meta/conf/bitbake.conf#n276

  i literally added a note about that to the YP docs in the last few
days.

rday
PRC Automation June 24, 2026, 11:38 p.m. UTC | #5
meta-ti / na / 20260624203026.1155961-1-afd

PRC Results: PASS

=========================================================
  check-yocto-patches: PASS
=========================================================
Patches
----------------------------------------
All patches passed



=========================================================
  apply-yocto-patch: PASS
=========================================================
master
=====================
Summary:
- Patch Series: [meta-ti][master/wrynose][PATCH v2] ti-linux-fw: Remove default SUMMARY line
- Submitter: From: Andrew Davis <afd@ti.com>
- Date: Date: Wed, 24 Jun 2026 15:30:26 -0500
- Num Patches: 1
- Mailing List (public inbox) Commit SHA: f4315be5bd9bd4c6d8db59bc58c7102a1b6796bb

Applied to:
- Repository: lcpd-prc-meta-ti
- Base Branch: master-wip
- Commit Author: Ryan Eatmon <reatmon@ti.com>
- Commit Subject: TEST: linux-ti-staging: Add testing dtbo and build command
- Commit SHA: 07bd4c181e2a400d4375ddad7a20fbba6578b133

Patches
----------------------------------------
All patches applied

wrynose
=====================
Summary:
- Patch Series: [meta-ti][master/wrynose][PATCH v2] ti-linux-fw: Remove default SUMMARY line
- Submitter: From: Andrew Davis <afd@ti.com>
- Date: Date: Wed, 24 Jun 2026 15:30:26 -0500
- Num Patches: 1
- Mailing List (public inbox) Commit SHA: f4315be5bd9bd4c6d8db59bc58c7102a1b6796bb

Applied to:
- Repository: lcpd-prc-meta-ti
- Base Branch: wrynose-wip
- Commit Author: Suhaas Joshi <s-joshi@ti.com>
- Commit Subject: tfa: Update TF-A for K3 devices to 2.15 tag
- Commit SHA: 88ce8160ec6c5804820555e0bc29dba23059a4a1

Patches
----------------------------------------
All patches applied



=========================================================
  check-yocto-repo: PASS
=========================================================
master
=====================
PASS

wrynose
=====================
PASS



=========================================================
  yocto-check-layers: PASS
=========================================================
master - PASS
=====================
All checks passed

wrynose - PASS
=====================
All checks passed
diff mbox series

Patch

diff --git a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
index ad025483..0b70d69d 100644
--- a/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
+++ b/meta-ti-bsp/recipes-bsp/ti-adc-fw/ti-adc-fw.bb
@@ -1,4 +1,4 @@ 
-DESCRIPTION = "TI ADC PCM6240 config prebuild binary firmware"
+SUMMARY = "TI ADC PCM6240 config prebuild binary firmware"
 
 require recipes-bsp/ti-linux-fw/ti-linux-fw.inc
 
diff --git a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
index 126c46df..d343a6aa 100644
--- a/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
+++ b/meta-ti-bsp/recipes-bsp/ti-linux-fw/ti-linux-fw.inc
@@ -1,5 +1,3 @@ 
-SUMMARY = "Common include for TI Linux firmware"
-
 LICENSE = "TI-TFL"
 LIC_FILES_CHKSUM = "file://LICENSE.ti;md5=b5aebf0668bdf95621259288c4a46d76"