poky.lists.yoctoproject.org archive mirror
 help / color / mirror / Atom feed
From: Alexander Kanavin <alex.kanavin@gmail.com>
To: poky@lists.yoctoproject.org
Cc: Alexander Kanavin <alex@linutronix.de>
Subject: [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description
Date: Thu, 14 Sep 2023 13:25:03 +0200	[thread overview]
Message-ID: <20230914112503.2214003-2-alex@linutronix.de> (raw)
In-Reply-To: <20230914112503.2214003-1-alex@linutronix.de>

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



  reply	other threads:[~2023-09-14 11:25 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-14 11:25 [PATCH 1/2] meta/conf/templates/default/conf-notes.txt: remove Alexander Kanavin
2023-09-14 11:25 ` Alexander Kanavin [this message]
  -- strict thread matches above, loose matches on Subject: below --
2024-01-31 12:37 Alexander Kanavin
2024-01-31 12:37 ` [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description Alexander Kanavin
2023-08-30 14:15 [PATCH 1/2] meta/conf/templates/default/conf-notes.txt: remove Alexander Kanavin
2023-08-30 14:15 ` [PATCH 2/2] meta-poky/conf/templates/default/conf-description.txt: add a template description 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=20230914112503.2214003-2-alex@linutronix.de \
    --to=alex.kanavin@gmail.com \
    --cc=alex@linutronix.de \
    --cc=poky@lists.yoctoproject.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;
as well as URLs for NNTP newsgroup(s).