From 07278078a65559400458d7ad07f18f93f5e20ebf Mon Sep 17 00:00:00 2001 From: Alexandre Belloni Date: Sat, 8 Jun 2013 00:34:38 +0200 Subject: [PATCH] Add documentation for the header style Signed-off-by: Alexandre Belloni Signed-off-by: Peter Korsgaard --- 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(-) diff --git a/docs/manual/adding-packages-autotools.txt b/docs/manual/adding-packages-autotools.txt index 1d5f30bc3c..1e7b058860 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 6ac073c359..b7388c81da 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 0d7504241b..faf70b1d89 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 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: + --------------------- -- 2.30.2