aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/writing-rules.txt
diff options
context:
space:
mode:
authorGravatar Alexandre Belloni <alexandre.belloni@free-electrons.com>2013-06-08 00:34:38 +0200
committerGravatar Peter Korsgaard <jacmet@sunsite.dk>2013-06-16 21:40:18 +0200
commit07278078a65559400458d7ad07f18f93f5e20ebf (patch)
tree59ca3d6a0530c7e1b9765e8cb0b442b30044bd68 /docs/manual/writing-rules.txt
parent9d191513512a4ff811508dd387928e00831a878d (diff)
downloadbuildroot-07278078a65559400458d7ad07f18f93f5e20ebf.tar.gz
buildroot-07278078a65559400458d7ad07f18f93f5e20ebf.tar.bz2
Add documentation for the header style
Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
Diffstat (limited to 'docs/manual/writing-rules.txt')
-rw-r--r--docs/manual/writing-rules.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt
index c9816a4402..b649c9fd8b 100644
--- a/docs/manual/writing-rules.txt
+++ b/docs/manual/writing-rules.txt
@@ -52,6 +52,18 @@ http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[].
The +.mk+ file
~~~~~~~~~~~~~~
+* Header: The file starts with a header. It contains the module name,
+preferably in lowercase, enclosed between separators made of 80 hashes. A
+blank line is mandatory after the header:
++
+---------------------
+################################################################################
+#
+# libfoo
+#
+################################################################################
+---------------------
++
* Assignment: use +=+ preceded and followed by one space:
+
---------------------