diff mbox series

[1/5] meta/conf/templates/default/conf-summary.txt: add a template summary

Message ID 20240216115222.3545462-1-alex@linutronix.de
State Accepted, archived
Commit aa96c2064a874714cfe4bac2fa622690e4c27ee4
Headers show
Series [1/5] meta/conf/templates/default/conf-summary.txt: add a template summary | expand

Commit Message

Alexander Kanavin Feb. 16, 2024, 11:52 a.m. UTC
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>
---
 meta/conf/templates/default/conf-summary.txt | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 meta/conf/templates/default/conf-summary.txt
diff mbox series

Patch

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