From patchwork Tue Nov 27 21:59:20 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Arnout Vandecappelle X-Patchwork-Id: 202306 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from whitealder.osuosl.org (whitealder.osuosl.org [140.211.166.138]) by ozlabs.org (Postfix) with ESMTP id EDA4F2C0087 for ; Wed, 28 Nov 2012 09:00:03 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id CAF868989B; Tue, 27 Nov 2012 21:59:59 +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 zimvP6S2nKds; Tue, 27 Nov 2012 21:59:52 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by whitealder.osuosl.org (Postfix) with ESMTP id 56ED78144B; Tue, 27 Nov 2012 21:59: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 982228F74A for ; Tue, 27 Nov 2012 21:59:32 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 96C9D80C12 for ; Tue, 27 Nov 2012 21:59:27 +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 V+sBYI0VpvNf for ; Tue, 27 Nov 2012 21:59:26 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from viper.mind.be (132.79-246-81.adsl-static.isp.belgacom.be [81.246.79.132]) by whitealder.osuosl.org (Postfix) with ESMTPS id 7B27680AF6 for ; Tue, 27 Nov 2012 21:59:26 +0000 (UTC) Received: from [172.16.2.6] (helo=vandecaa-laptop) by viper.mind.be with esmtp (Exim 4.69) (envelope-from ) id 1TdTBa-0006BM-Rz; Tue, 27 Nov 2012 22:59:23 +0100 Received: from arnout by vandecaa-laptop with local (Exim 4.80) (envelope-from ) id 1TdTBZ-0007uU-QZ; Tue, 27 Nov 2012 22:59:21 +0100 From: "Arnout Vandecappelle (Essensium/Mind)" To: buildroot@busybox.net Date: Tue, 27 Nov 2012 22:59:20 +0100 Message-Id: <1354053560-30352-5-git-send-email-arnout@mind.be> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1354053560-30352-1-git-send-email-arnout@mind.be> References: <1354053560-30352-1-git-send-email-arnout@mind.be> Subject: [Buildroot] [PATCHv3 for-2012.11 5/5] manual: restructure 'Adding packages' chapter 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 From: "Arnout Vandecappelle (Essensium/Mind)" The depends-on-vs-select part of the manual really deserves its own section title (especially because it is referred to and the xref gets a 'sinpara' in PDF if the section doesn't have a title). So restructure the surrounding sections to reduce the section nesting depth. Signed-off-by: Arnout Vandecappelle (Essensium/Mind) Acked-by: Samuel Martin --- docs/manual/adding-packages-directory.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt index 5903ed1..5d17aac 100644 --- a/docs/manual/adding-packages-directory.txt +++ b/docs/manual/adding-packages-directory.txt @@ -11,11 +11,11 @@ Some packages have been grouped by topic in a sub-directory: one of these categories, then create your package directory in these. New subdirectories are discouraged, however. +Config.in+ file -^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~ Then, create a file named +Config.in+. This file will contain the option descriptions related to our +libfoo+ software that will be used and displayed in the configuration tool. It should basically contain: @@ -49,10 +49,13 @@ supposed to contain anything but the 'bare' name of the package. -------------------------- source "package/libfoo/Config.in" -------------------------- [[depends-on-vs-select]] +Choosing +depends on+ or +select+ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + The +Config.in+ file of your package must also ensure that dependencies are enabled. Typically, Buildroot uses the following rules: * Use a +select+ type of dependency for dependencies on @@ -162,11 +165,11 @@ package. Further formatting details: see xref:writing-rules-config-in[the coding style]. The +.mk+ file -^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~ Finally, here's the hardest part. Create a file named +libfoo.mk+. It describes how the package should be downloaded, configured, built, installed, etc.