mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Juergen Borleis <jbe@pengutronix.de>
To: ptxdist@pengutronix.de
Subject: [ptxdist] [PATCH 3/3] doc: improve the suboption name scheme description
Date: Fri, 22 Feb 2019 14:18:51 +0100	[thread overview]
Message-ID: <20190222131851.7986-3-jbe@pengutronix.de> (raw)
In-Reply-To: <20190222131851.7986-1-jbe@pengutronix.de>

Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
---
 doc/dev_manual.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst
index 523ecde28..e17aa9b1b 100644
--- a/doc/dev_manual.rst
+++ b/doc/dev_manual.rst
@@ -881,9 +881,10 @@ add on demand to the ``configure`` parameters:
 
     endif
 
-.. note:: To extend the base name by a suboption name as a trailing
-  component gives PTXdist the ability to detect a change in the package’s
-  settings to force its rebuild.
+.. important:: Always follow the rule to extend the base name by a suboption
+  name as the trailing part of the variable name. This gives PTXdist the ability
+  to detect a change in the package’s settings (via menuconfig) to force its
+  rebuild on demand.
 
 To make usage of the new menu entries, we must check them in the rule
 file and add the correct parameters:
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

      parent reply	other threads:[~2019-02-22 13:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-22 13:18 [ptxdist] [PATCH 1/3] doc: mention dedicated PTXdist macros to be used in rule files Juergen Borleis
2019-02-22 13:18 ` [ptxdist] [PATCH 2/3] doc: follow the rule to use breaking lines Juergen Borleis
2019-02-22 13:18 ` Juergen Borleis [this message]

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=20190222131851.7986-3-jbe@pengutronix.de \
    --to=jbe@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /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