diff mbox series

[2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description

Message ID 20240131123756.1098481-2-alex@linutronix.de (mailing list archive)
State New
Headers show
Series [1/2] meta/conf/templates/default/conf-notes.txt: remove | expand

Commit Message

Alexander Kanavin Jan. 31, 2024, 12:37 p.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 descriptions can be provided via conf-description.txt and
this patch adds such a description for the poky default template.

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

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
---
 meta-poky/conf/templates/default/conf-description.txt | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 meta-poky/conf/templates/default/conf-description.txt
diff mbox series

Patch

diff --git a/meta-poky/conf/templates/default/conf-description.txt b/meta-poky/conf/templates/default/conf-description.txt
new file mode 100644
index 00000000000..8fc03030c7f
--- /dev/null
+++ b/meta-poky/conf/templates/default/conf-description.txt
@@ -0,0 +1 @@ 
+This is the default build configuration for the Poky reference distribution.