mirror/buildroot
1
0
Fork 0
mirror of https://gitlab.com/buildroot.org/buildroot.git synced 2026-10-01 06:21:56 -09:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the header style

Browse Source 
Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
This commit is contained in:
Alexandre Belloni
2013-06-08 00:34:38 +02:00
committed by Peter Korsgaard
parent 9d19151351
commit 07278078a6
4 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manual/adding-packages-autotools.txt
View File

@@ -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

4
docs/manual/adding-packages-cmake.txt
View File

@@ -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

4
docs/manual/adding-packages-generic.txt
View File

@@ -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

12
docs/manual/writing-rules.txt
View File

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