diff options
| author | Alexandre Belloni <alexandre.belloni@free-electrons.com> | 2013-06-08 00:34:38 +0200 |
|---|---|---|
| committer | Peter Korsgaard <jacmet@sunsite.dk> | 2013-06-16 21:40:18 +0200 |
| commit | 07278078a65559400458d7ad07f18f93f5e20ebf (patch) | |
| tree | 59ca3d6a0530c7e1b9765e8cb0b442b30044bd68 | |
| parent | 9d191513512a4ff811508dd387928e00831a878d (diff) | |
| download | buildroot-novena-07278078a65559400458d7ad07f18f93f5e20ebf.tar.gz buildroot-novena-07278078a65559400458d7ad07f18f93f5e20ebf.zip | |
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.txt | 4 | ||||
| -rw-r--r-- | docs/manual/adding-packages-cmake.txt | 4 | ||||
| -rw-r--r-- | docs/manual/adding-packages-generic.txt | 4 | ||||
| -rw-r--r-- | 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 1d5f30bc3..1e7b05886 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 6ac073c35..b7388c81d 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 0d7504241..faf70b1d8 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 c9816a440..b649c9fd8 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: + --------------------- |