diff mbox series

[1/3] meta/conf/fragments: harmonize fragment summaries and descriptions

Message ID 20260821-sbom-cve-check-fragment-desc-v1-1-e06feb747b07@bootlin.com
State New
Headers show
Series Disk space monitoring fragment and minor tooling tweaks | expand

Commit Message

Antonin Godard Aug. 21, 2026, 12:26 p.m. UTC
Use the present tense for fragment summaries, so that the
'bitbake-config-build list-fragments' has a coherent output.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 .../fragments/yocto-autobuilder/autobuilder-resource-constraints.conf | 4 ++--
 meta/conf/fragments/yocto-autobuilder/autobuilder.conf                | 4 ++--
 meta/conf/fragments/yocto/sbom-cve-check.conf                         | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)

Comments

Quentin Schulz Aug. 21, 2026, 2:01 p.m. UTC | #1
Hi Antonin,

On 8/21/26 2:26 PM, Antonin Godard via lists.openembedded.org wrote:
> Use the present tense for fragment summaries, so that the
> 'bitbake-config-build list-fragments' has a coherent output.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   .../fragments/yocto-autobuilder/autobuilder-resource-constraints.conf | 4 ++--
>   meta/conf/fragments/yocto-autobuilder/autobuilder.conf                | 4 ++--
>   meta/conf/fragments/yocto/sbom-cve-check.conf                         | 2 +-
>   3 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf b/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf
> index 58cadd92b6..c3fc9990eb 100644
> --- a/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf
> +++ b/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf
> @@ -1,5 +1,5 @@
> -BB_CONF_FRAGMENT_SUMMARY = "Resource constraint variables used on the Yocto Projects autobuilder"
> -BB_CONF_FRAGMENT_DESCRIPTION = "Resource constraint variables used on the Yocto Projects autobuilder"
> +BB_CONF_FRAGMENT_SUMMARY = "Set resource constraint variables for Yocto Project Autobuilder builds"
> +BB_CONF_FRAGMENT_DESCRIPTION = "Resource constraint variables for Yocto Project Autobuilder builds"
>   
>   BB_NUMBER_THREADS = '16'
>   BB_NUMBER_PARSE_THREADS = '16'
> diff --git a/meta/conf/fragments/yocto-autobuilder/autobuilder.conf b/meta/conf/fragments/yocto-autobuilder/autobuilder.conf
> index 81adebe5ae..1f16c87d98 100644
> --- a/meta/conf/fragments/yocto-autobuilder/autobuilder.conf
> +++ b/meta/conf/fragments/yocto-autobuilder/autobuilder.conf
> @@ -1,5 +1,5 @@
> -BB_CONF_FRAGMENT_SUMMARY = "Default variables used on the Yocto Projects autobuilder builds"
> -BB_CONF_FRAGMENT_DESCRIPTION = "Default variables used on the Yocto Projects autobuilder builds"
> +BB_CONF_FRAGMENT_SUMMARY = "Set default variables for Yocto Project Autobuilder builds"
> +BB_CONF_FRAGMENT_DESCRIPTION = "Default variables for Yocto Project Autobuilder builds"
>   
>   QEMU_USE_KVM ?= 'True'
>   INHERIT += 'report-error'
> diff --git a/meta/conf/fragments/yocto/sbom-cve-check.conf b/meta/conf/fragments/yocto/sbom-cve-check.conf
> index 46f6965a0d..f4178af4ec 100644
> --- a/meta/conf/fragments/yocto/sbom-cve-check.conf
> +++ b/meta/conf/fragments/yocto/sbom-cve-check.conf
> @@ -1,4 +1,4 @@
> -BB_CONF_FRAGMENT_SUMMARY = "This fragment enables sbom-cve-check with recommended default options"
> +BB_CONF_FRAGMENT_SUMMARY = "Enable sbom-cve-check with recommended default options"
>   BB_CONF_FRAGMENT_DESCRIPTION = "Enables sbom-cve-check and applies the following configurations: \

This denotes from the rest of this patch in two ways:
- has a verb while other BB_CONF_FRAGMENT_DESCRIPTION above don't,
- uses the (implicit) third person while the rest uses imperative (I 
believe that's the correct term?),

It also denotes from the tense used in its own BB_CONF_FRAGMENT_SUMMARY 
(Enable/Enables and applies).

Cheers,
Quentin
diff mbox series

Patch

diff --git a/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf b/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf
index 58cadd92b6..c3fc9990eb 100644
--- a/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf
+++ b/meta/conf/fragments/yocto-autobuilder/autobuilder-resource-constraints.conf
@@ -1,5 +1,5 @@ 
-BB_CONF_FRAGMENT_SUMMARY = "Resource constraint variables used on the Yocto Projects autobuilder"
-BB_CONF_FRAGMENT_DESCRIPTION = "Resource constraint variables used on the Yocto Projects autobuilder"
+BB_CONF_FRAGMENT_SUMMARY = "Set resource constraint variables for Yocto Project Autobuilder builds"
+BB_CONF_FRAGMENT_DESCRIPTION = "Resource constraint variables for Yocto Project Autobuilder builds"
 
 BB_NUMBER_THREADS = '16'
 BB_NUMBER_PARSE_THREADS = '16'
diff --git a/meta/conf/fragments/yocto-autobuilder/autobuilder.conf b/meta/conf/fragments/yocto-autobuilder/autobuilder.conf
index 81adebe5ae..1f16c87d98 100644
--- a/meta/conf/fragments/yocto-autobuilder/autobuilder.conf
+++ b/meta/conf/fragments/yocto-autobuilder/autobuilder.conf
@@ -1,5 +1,5 @@ 
-BB_CONF_FRAGMENT_SUMMARY = "Default variables used on the Yocto Projects autobuilder builds"
-BB_CONF_FRAGMENT_DESCRIPTION = "Default variables used on the Yocto Projects autobuilder builds"
+BB_CONF_FRAGMENT_SUMMARY = "Set default variables for Yocto Project Autobuilder builds"
+BB_CONF_FRAGMENT_DESCRIPTION = "Default variables for Yocto Project Autobuilder builds"
 
 QEMU_USE_KVM ?= 'True'
 INHERIT += 'report-error'
diff --git a/meta/conf/fragments/yocto/sbom-cve-check.conf b/meta/conf/fragments/yocto/sbom-cve-check.conf
index 46f6965a0d..f4178af4ec 100644
--- a/meta/conf/fragments/yocto/sbom-cve-check.conf
+++ b/meta/conf/fragments/yocto/sbom-cve-check.conf
@@ -1,4 +1,4 @@ 
-BB_CONF_FRAGMENT_SUMMARY = "This fragment enables sbom-cve-check with recommended default options"
+BB_CONF_FRAGMENT_SUMMARY = "Enable sbom-cve-check with recommended default options"
 BB_CONF_FRAGMENT_DESCRIPTION = "Enables sbom-cve-check and applies the following configurations: \
  - Adds the sbom-cve-check class to IMAGE_CLASSES. \
  - Configures CVE database recipes to fetch the latest git revision using AUTOREV. \