public inbox for openembedded-core@lists.openembedded.org
 help / color / mirror / Atom feed
From: Alexander Kanavin <alex.kanavin@gmail.com>
To: openembedded-core@lists.openembedded.org
Cc: Alexander Kanavin <alex@linutronix.de>
Subject: [PATCH 1/5] meta/conf/templates/default/conf-description.txt: add a template description
Date: Wed, 31 Jan 2024 13:39:04 +0100	[thread overview]
Message-ID: <20240131123908.1098544-1-alex@linutronix.de> (raw)

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 oe-core 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/conf/templates/default/conf-description.txt | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 meta/conf/templates/default/conf-description.txt

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.
-- 
2.39.2



             reply	other threads:[~2024-01-31 12:39 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-31 12:39 Alexander Kanavin [this message]
2024-01-31 12:39 ` [PATCH 2/5] meta/lib/bblayers/buildconf.py: add support for configuration descriptions Alexander Kanavin
2024-01-31 12:39 ` [PATCH 3/5] scripts/oe-setup-builddir: " Alexander Kanavin
2024-01-31 12:39 ` [PATCH 4/5] scripts/oe-setup-layers: write a list of layer paths into the checkout's top dir Alexander Kanavin
2024-01-31 12:39 ` [PATCH 5/5] oe-setup-build: add a tool for discovering config templates and setting up builds Alexander Kanavin
2024-02-08 13:40   ` Jermain Horsman
2024-02-08 15:54     ` [OE-core] " Alexander Kanavin
2024-02-08 19:07       ` Jermain Horsman
2024-02-15 15:00 ` [OE-core] [PATCH 1/5] meta/conf/templates/default/conf-description.txt: add a template description Richard Purdie
2024-02-16 10:57   ` Alexander Kanavin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240131123908.1098544-1-alex@linutronix.de \
    --to=alex.kanavin@gmail.com \
    --cc=alex@linutronix.de \
    --cc=openembedded-core@lists.openembedded.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox