summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas De Schampheleire <patrickdepinguin@gmail.com>2013-12-15 13:20:40 +0100
committerPeter Korsgaard <peter@korsgaard.com>2013-12-15 16:26:02 +0100
commitb47c8cc8aa51a6fd3de8a60c5090c39801c81afd (patch)
treea20b06dc9f1154ad45cd109409bd7e3b79fb0ced
parent8da745f04a0e45be17c53b4a1475798d9b300811 (diff)
downloadbuildroot-b47c8cc8aa51a6fd3de8a60c5090c39801c81afd.tar.gz
buildroot-b47c8cc8aa51a6fd3de8a60c5090c39801c81afd.zip
manual: clarify format of comments about dependency on Linux kernel
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
-rw-r--r--docs/manual/adding-packages-directory.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt
index 36b709308c..57f3204412 100644
--- a/docs/manual/adding-packages-directory.txt
+++ b/docs/manual/adding-packages-directory.txt
@@ -253,6 +253,22 @@ use in the comment.
** Dependency symbol: +!BR2_PREFER_STATIC_LIB+
** Comment string: +dynamic library+
+Dependencies on a Linux kernel built by buildroot
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Some packages need a Linux kernel to be built by buildroot. These are
+typically kernel modules or firmware. A comment should be added in the
+Config.in file to express this dependency, similar to dependencies on
+toolchain options. The general format is:
+
+--------------------------
+foo needs a Linux kernel to be built
+--------------------------
+
+If there is a dependency on both toolchain options and the Linux
+kernel, use this format:
+--------------------------
+foo needs a toolchain w/ featA, featB, featC and a Linux kernel to be built
+--------------------------
The +.mk+ file
~~~~~~~~~~~~~~
OpenPOWER on IntegriCloud