| Message ID | 20230830141512.656130-1-alex@linutronix.de |
|---|---|
| State | New |
| Headers | show |
| Series | meta/conf/templates/default/conf-description.txt: add a template description | expand |
On 30 Aug 2023, at 15:15, Alexander Kanavin via lists.openembedded.org <alex.kanavin=gmail.com@lists.openembedded.org> wrote: > 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
On Tue, 12 Sept 2023 at 12:58, Ross Burton <Ross.Burton@arm.com> wrote: > > On 30 Aug 2023, at 15:15, Alexander Kanavin via lists.openembedded.org <alex.kanavin=gmail.com@lists.openembedded.org> wrote: > > 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
On Tue, 12 Sept 2023 at 13:10, Alexander Kanavin <alex.kanavin@gmail.com> wrote: > 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
diff --git a/meta/conf/templates/default/conf-description.txt b/meta/conf/templates/default/conf-description.txt new file mode 100644 index 00000000000..e49172fa0ce --- /dev/null +++ b/meta/conf/templates/default/conf-description.txt @@ -0,0 +1 @@ +This is the default build configuration for the openembedded-core layer.
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. Signed-off-by: Alexander Kanavin <alex@linutronix.de> --- meta/conf/templates/default/conf-description.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 meta/conf/templates/default/conf-description.txt