Add documentation for the header style
Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com> Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
This commit is contained in:
parent
9d19151351
commit
07278078a6
|
@ -13,11 +13,11 @@ First, let's see how to write a +.mk+ file for an autotools-based
|
||||||
package, with an example :
|
package, with an example :
|
||||||
|
|
||||||
------------------------
|
------------------------
|
||||||
01: #############################################################
|
01: ################################################################################
|
||||||
02: #
|
02: #
|
||||||
03: # libfoo
|
03: # libfoo
|
||||||
04: #
|
04: #
|
||||||
05: #############################################################
|
05: ################################################################################
|
||||||
06:
|
06:
|
||||||
07: LIBFOO_VERSION = 1.0
|
07: LIBFOO_VERSION = 1.0
|
||||||
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
||||||
|
|
|
@ -13,11 +13,11 @@ First, let's see how to write a +.mk+ file for a CMake-based package,
|
||||||
with an example :
|
with an example :
|
||||||
|
|
||||||
------------------------
|
------------------------
|
||||||
01: #############################################################
|
01: ################################################################################
|
||||||
02: #
|
02: #
|
||||||
03: # libfoo
|
03: # libfoo
|
||||||
04: #
|
04: #
|
||||||
05: #############################################################
|
05: ################################################################################
|
||||||
06:
|
06:
|
||||||
07: LIBFOO_VERSION = 1.0
|
07: LIBFOO_VERSION = 1.0
|
||||||
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
||||||
|
|
|
@ -15,11 +15,11 @@ system is based on hand-written Makefiles or shell scripts.
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
------------------------------
|
------------------------------
|
||||||
01: #############################################################
|
01: ################################################################################
|
||||||
02: #
|
02: #
|
||||||
03: # libfoo
|
03: # libfoo
|
||||||
04: #
|
04: #
|
||||||
05: #############################################################
|
05: ################################################################################
|
||||||
06:
|
06:
|
||||||
07: LIBFOO_VERSION = 1.0
|
07: LIBFOO_VERSION = 1.0
|
||||||
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
08: LIBFOO_SOURCE = libfoo-$(LIBFOO_VERSION).tar.gz
|
||||||
|
|
|
@ -52,6 +52,18 @@ http://kernel.org/doc/Documentation/kbuild/kconfig-language.txt[].
|
||||||
The +.mk+ file
|
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:
|
* Assignment: use +=+ preceded and followed by one space:
|
||||||
+
|
+
|
||||||
---------------------
|
---------------------
|
||||||
|
|
Loading…
Reference in New Issue
Block a user