path: root/docs
diff options
authorGravatar Yann E. MORIN <yann.morin.1998@free.fr>2016-06-04 18:30:47 +0200
committerGravatar Thomas Petazzoni <thomas.petazzoni@free-electrons.com>2016-06-07 21:36:04 +0200
commitab18cf8327ca5b093f65d7e864e7706d75846a54 (patch)
tree1f814894035ec132f6a8f65d4690a3326afed5c7 /docs
parentcc1411d0b1b159e208d141fb4ba3c6f3508e1336 (diff)
core/pkg-generic: add support for package-defined help
Add a package-variable to store the package-specific make rules. Although this variable would be seldom used, we still document it. However, we make sure the documentation explicitly states that this variable should not be used (if it needs to be, the submitter of a package will be told so during reviews). Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Arnout Vandecappelle <arnout@mind.be> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Diffstat (limited to 'docs')
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index 8ed7fe8ee2..de8aca20b5 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -497,6 +497,12 @@ different steps of the build process.
systemd is selected as the init system in the configuration, only
+* +LIBFOO_HELP_CMDS+ lists the actions to print the package help, which
+ is included to the main +make help+ output. These commands can print
+ anything in any format.
+ This is seldom used, as packages rarely have custom rules. *Do not use
+ this variable*, unless you really know that you need to print help.
The preferred way to define these variables is: