Add documentation for the header style

Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>

diff --git a/docs/manual/adding-packages-autotools.txt b/docs/manual/adding-packages-autotools.txt
index 1d5f30bc3c9ecc3d355cb9cf1287a6776a8c57e6..1e7b0588600b5c84e9d4edc5d8ae9eeb1a9c013d 100644 (file)
--- 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 6ac073c3595934922ebc82538cf42378f945b0b7..b7388c81da114a1ea5096f4cd57425eb0cf4cc10 100644 (file)
--- 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 0d7504241bd4e5b5fd7f663f7d1aa10553ee6d7d..faf70b1d897b38f3735d3b8cb3cbcb7e364f3768 100644 (file)
--- 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 c9816a44021671d89be62d56c526e72a2699d826..b649c9fd8ba9a607d4d027e4de53b7af973b34ed 100644 (file)
--- 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:
 +
 ---------------------