summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexandre Belloni <alexandre.belloni@free-electrons.com>2013-06-07 22:34:38 (GMT)
committer Peter Korsgaard <jacmet@sunsite.dk>2013-06-16 19:40:18 (GMT)
commit07278078a65559400458d7ad07f18f93f5e20ebf (patch)
tree59ca3d6a0530c7e1b9765e8cb0b442b30044bd68
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>
-rw-r--r--docs/manual/adding-packages-autotools.txt4
-rw-r--r--docs/manual/adding-packages-cmake.txt4
-rw-r--r--docs/manual/adding-packages-generic.txt4
-rw-r--r--docs/manual/writing-rules.txt12
4 files changed, 18 insertions, 6 deletions
diff --git a/docs/manual/adding-packages-autotools.txt b/docs/manual/adding-packages-autotools.txt
index 1d5f30b..1e7b058 100644
--- a/docs/manual/adding-packages-autotools.txt
+++ b/docs/manual/adding-packages-autotools.txt
@@ -13,11 +13,11 @@ First, let's see how to write a +.mk+ file for an autotools-based
package, with an example :
------------------------
-01: #############################################################
+01: ################################################################################
02: #
03: # libfoo
04: #
-05: #############################################################
+05: ################################################################################
06:
07: LIBFOO_VERSION = 1.0
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
diff --git a/docs/manual/adding-packages-cmake.txt b/docs/manual/adding-packages-cmake.txt
index 6ac073c..b7388c8 100644
--- a/docs/manual/adding-packages-cmake.txt
+++ b/docs/manual/adding-packages-cmake.txt
@@ -13,11 +13,11 @@ First, let's see how to write a +.mk+ file for a CMake-based package,
with an example :
------------------------
-01: #############################################################
+01: ################################################################################
02: #
03: # libfoo
04: #
-05: #############################################################
+05: ################################################################################
06:
07: LIBFOO_VERSION = 1.0
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index 0d75042..faf70b1 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -15,11 +15,11 @@ system is based on hand-written Makefiles or shell scripts.
^^^^^^^^^^^^^^^^^^^^^^^^^^
------------------------------
-01: #############################################################
+01: ################################################################################
02: #
03: # libfoo
04: #
-05: #############################################################
+05: ################################################################################
06:
07: LIBFOO_VERSION = 1.0
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt
index c9816a4..b649c9f 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:
+
---------------------