Patchwork Add documentation for the header style

login
register
mail settings
Submitter Alexandre Belloni
Date June 7, 2013, 10:34 p.m.
Message ID <1370644478-7343-1-git-send-email-alexandre.belloni@free-electrons.com>
Download mbox | patch
Permalink /patch/249870/
State Accepted
Commit 07278078a65559400458d7ad07f18f93f5e20ebf
Headers show

Comments

Alexandre Belloni - June 7, 2013, 10:34 p.m.
Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
---
 docs/manual/adding-packages-autotools.txt |  4 ++--
 docs/manual/adding-packages-cmake.txt     |  4 ++--
 docs/manual/adding-packages-generic.txt   |  4 ++--
 docs/manual/writing-rules.txt             | 12 ++++++++++++
 4 files changed, 18 insertions(+), 6 deletions(-)
Peter Korsgaard - June 16, 2013, 7:40 p.m.
>>>>> "Alexandre" == Alexandre Belloni <alexandre.belloni@free-electrons.com> writes:

 Alexandre> Signed-off-by: Alexandre Belloni
 Alexandre> <alexandre.belloni@free-electrons.com>

Committed, thanks.

Patch

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:
 +
 ---------------------