From patchwork Fri Jun 7 22:34:38 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandre Belloni X-Patchwork-Id: 249870 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from silver.osuosl.org (silver.osuosl.org [140.211.166.136]) by ozlabs.org (Postfix) with ESMTP id 5B1282C02AC for ; Sat, 8 Jun 2013 08:34:55 +1000 (EST) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 75F2631EF9; Fri, 7 Jun 2013 22:34:51 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ZUZ2T3FfPGxI; Fri, 7 Jun 2013 22:34:49 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by silver.osuosl.org (Postfix) with ESMTP id B8AA731E5D; Fri, 7 Jun 2013 22:34:48 +0000 (UTC) X-Original-To: buildroot@lists.busybox.net Delivered-To: buildroot@osuosl.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ash.osuosl.org (Postfix) with ESMTP id A9BC58F7B1 for ; Fri, 7 Jun 2013 22:34:54 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 9DF908CF46 for ; Fri, 7 Jun 2013 22:34:47 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id IXatYnhsyEAT for ; Fri, 7 Jun 2013 22:34:46 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail.free-electrons.com (mail.free-electrons.com [94.23.35.102]) by whitealder.osuosl.org (Postfix) with ESMTP id 30FD08CF30 for ; Fri, 7 Jun 2013 22:34:46 +0000 (UTC) Received: by mail.free-electrons.com (Postfix, from userid 106) id 1DCD67AF; Sat, 8 Jun 2013 00:34:44 +0200 (CEST) Received: from localhost (AToulouse-651-1-76-8.w92-156.abo.wanadoo.fr [92.156.131.8]) by mail.free-electrons.com (Postfix) with ESMTPSA id 7857C749; Sat, 8 Jun 2013 00:34:44 +0200 (CEST) From: Alexandre Belloni To: buildroot@busybox.net Date: Sat, 8 Jun 2013 00:34:38 +0200 Message-Id: <1370644478-7343-1-git-send-email-alexandre.belloni@free-electrons.com> X-Mailer: git-send-email 1.8.1.2 Subject: [Buildroot] [PATCH] Add documentation for the header style X-BeenThere: buildroot@busybox.net X-Mailman-Version: 2.1.14 Precedence: list List-Id: Discussion and development of buildroot List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: buildroot-bounces@busybox.net Sender: buildroot-bounces@busybox.net Signed-off-by: Alexandre Belloni --- 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 1d5f30b..1e7b058 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 6ac073c..b7388c8 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 0d75042..faf70b1 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 c9816a4..b649c9f 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: + ---------------------