summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuergen Borleis <jbe@pengutronix.de>2019-02-22 14:18:51 +0100
committerMichael Olbrich <m.olbrich@pengutronix.de>2019-02-26 09:13:26 +0100
commit991a672e9c8247ab7ebe581d5dda4706e8cae5b8 (patch)
treee5af2545f124bbe78efc9260ccd90c0f4df4c022
parent64736fb275d0bc9286a3b47177a3b2d75aa0aa1f (diff)
downloadptxdist-991a672e9c8247ab7ebe581d5dda4706e8cae5b8.tar.gz
ptxdist-991a672e9c8247ab7ebe581d5dda4706e8cae5b8.tar.xz
doc: improve the suboption name scheme description
Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
-rw-r--r--doc/dev_manual.rst7
1 files 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: