]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core.git/commitdiff
meta/conf/templates/default/conf-summary.txt: add a template summary
authorAlexander Kanavin <alex.kanavin@gmail.com>
Fri, 16 Feb 2024 11:52:18 +0000 (12:52 +0100)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Mon, 19 Feb 2024 11:47:04 +0000 (11:47 +0000)
Existing conf-notes.txt is not adequate in situations where the user
needs to select a config template from several, or get an overview of them and
is interested only in a brief explanation of what the template is for,
but not extended multi-paragraph instructions for how to use it.

Such summaries can be provided via conf-summary.txt and
this patch adds such a summary for the oe-core default template.

Updates to the tools and a tool for selecting templates which
will make specific use of the summary will follow.

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
meta/conf/templates/default/conf-summary.txt [new file with mode: 0644]

diff --git a/meta/conf/templates/default/conf-summary.txt b/meta/conf/templates/default/conf-summary.txt
new file mode 100644 (file)
index 0000000..e49172f
--- /dev/null
@@ -0,0 +1 @@
+This is the default build configuration for the openembedded-core layer.