Commit 07278078 authored by Alexandre Belloni's avatar Alexandre Belloni Committed by Peter Korsgaard
Browse files

Add documentation for the header style 



Signed-off-by: default avatarAlexandre Belloni <alexandre.belloni@free-electrons.com>
Signed-off-by: default avatarPeter Korsgaard <jacmet@sunsite.dk>
parent 9d191513

docs/manual/adding-packages-autotools.txt

+2 −2
Original line number Diff line number Diff line
@@ -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

docs/manual/adding-packages-cmake.txt

+2 −2
Original line number Diff line number Diff line
@@ -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

docs/manual/adding-packages-generic.txt

+2 −2
Original line number Diff line number Diff line
@@ -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

docs/manual/writing-rules.txt

+12 −0
Original line number Diff line number Diff line
@@ -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:

+

---------------------