Skip to contentSkip to conversation

meta/conf/templates/default/conf-description.txt: add a template description

PATCH In review Alexander Kanavin 2 participants 4 messages Aug 30, 2023 – Sep 12, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 meta/conf/templates/default/conf-description.txt: add a template description

There is a need to separate the template notes (which are lengthy instructions about how to use the template) and template description (which is a short explanation of what the template is for).

This patch adds such a description for the default oe-core template, and updates to the tools will follow.

---
 meta/conf/templates/default/conf-description.txt | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 meta/conf/templates/default/conf-description.txt
meta/conf/templates/default/conf-description.txt new file +1 -0
new file mode 100644
index 00000000000..e49172fa0ce
@@ -0,0 +1 @@
+This is the default build configuration for the openembedded-core layer.
Signature · 1 line
2.30.2
#1 lore raw
Quoted 3 lines · Alexander Kanavin via lists.openembedded.org

There is a need to separate the template notes (which are lengthy instructions about how to use the template) and template description (which is a short explanation of what the template is for).

What’s this need? I don’t have a problem with the code in the patches, but the need or purpose for this extra configuration file is not documented or explained anywhere.

Cheers,
Ross

#2 lore raw
Quoted 7 lines · Ross Burton
Quoted 3 lines · Alexander Kanavin via lists.openembedded.org

There is a need to separate the template notes (which are lengthy instructions about how to use the template) and template description (which is a short explanation of what the template is for).

What’s this need? I don’t have a problem with the code in the patches, but the need or purpose for this extra configuration file is not documented or explained anywhere.

When a user needs to select a config template or get an overview of them, oe-setup-build (or other similar tooling) would show the notes, but not the description. The code is written and tested, I'm just not sending it because feature freeze:

https://git.yoctoproject.org/poky-contrib/commit/?h=akanavin/setup-layers-tweaks

Alex

#3 lore raw
Quoted 3 lines · Alexander Kanavin

When a user needs to select a config template or get an overview of them, oe-setup-build (or other similar tooling) would show the notes, but not the description.

Got this backwards of course :)

Alex