From patchwork Sun Nov 11 13:14:47 2012 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Samuel Martin X-Patchwork-Id: 198268 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 EAC712C0040 for ; Mon, 12 Nov 2012 00:16:42 +1100 (EST) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 7CE3231485; Sun, 11 Nov 2012 13:16:40 +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 ydt0gQlXDW63; Sun, 11 Nov 2012 13:16:32 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by silver.osuosl.org (Postfix) with ESMTP id 7145630DF7; Sun, 11 Nov 2012 13:16:04 +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 78E3E8F753 for ; Sun, 11 Nov 2012 13:15:39 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id 46BD18C2E3 for ; Sun, 11 Nov 2012 13:15:35 +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 Kwku3HhAMRxA for ; Sun, 11 Nov 2012 13:15:33 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mail-wg0-f53.google.com (mail-wg0-f53.google.com [74.125.82.53]) by whitealder.osuosl.org (Postfix) with ESMTPS id 5B5248C2A6 for ; Sun, 11 Nov 2012 13:15:33 +0000 (UTC) Received: by mail-wg0-f53.google.com with SMTP id dr1so2897138wgb.10 for ; Sun, 11 Nov 2012 05:15:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; bh=9/+CVIBsGiSFC2ErbMKYs37GJ7DZe6aJyQLqYo9RcV4=; b=FvXK6tHNCK091OE48fAfKCr1EmOLEjm7MO3IC0HGPj96eLKHuWZxOCETezKWNdiDVn UMoapgzrYqqTWi94JTb6L9G0uYDh+hBqLm6YtuMc2ViOuLxUigc8ljq1n7RWiNkaw3le lc9DC+OSUseDIDfYs4N6Qf6s744feY2J3xHrEwDGgV2qhVr5skvkurhG283IGiA6QGYO +Sxu8T8hsY0GHtBcAjscsaEthcjA1rfrlV/I80KGpvTDq7GDfjolZAUOXphUhDLApjgr Z+/ErDw6mxjKcToZEVL3VT80vwbNZkjlJykCpViKKdXI7IlCnR2NVu0Dlwtxl/kVfF/G QYjg== Received: by 10.180.80.131 with SMTP id r3mr10823183wix.0.1352639733071; Sun, 11 Nov 2012 05:15:33 -0800 (PST) Received: from localhost.localdomain (ivr94-4-82-229-165-48.fbx.proxad.net. [82.229.165.48]) by mx.google.com with ESMTPS id hv4sm10262550wib.0.2012.11.11.05.15.31 (version=SSLv3 cipher=OTHER); Sun, 11 Nov 2012 05:15:32 -0800 (PST) From: Samuel Martin To: buildroot@busybox.net Date: Sun, 11 Nov 2012 14:14:47 +0100 Message-Id: <1352639701-27829-10-git-send-email-s.martin49@gmail.com> X-Mailer: git-send-email 1.8.0 In-Reply-To: <1352639701-27829-1-git-send-email-s.martin49@gmail.com> References: <1352639701-27829-1-git-send-email-s.martin49@gmail.com> Subject: [Buildroot] [PATCH 09/23] manual: adding-package-directory.txt: update, cleanup and typo fixes 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: Samuel Martin diff --git a/docs/manual/adding-packages-directory.txt b/docs/manual/adding-packages-directory.txt index 6030e08..35d28b6 100644 --- a/docs/manual/adding-packages-directory.txt +++ b/docs/manual/adding-packages-directory.txt @@ -49,6 +49,7 @@ supposed to contain anything but the 'bare' name of the package. source "package/libfoo/Config.in" -------------------------- +[[depends-on-vs-select]] The +Config.in+ file of your package must also ensure that dependencies are enabled. Typically, Buildroot uses the following rules: @@ -59,15 +60,26 @@ rules: dependencies are selected. For example, the _libgtk2_ package uses +select BR2_PACKAGE_LIBGLIB2+ to make sure this library is also enabled. + The +select+ keyword express the dependency with a backward + semantic. * Use a +depends on+ type of dependency when the user really needs to be aware of the dependency. Typically, Buildroot uses this type of - dependency for dependencies on toolchain options (large file - support, RPC support, IPV6 support), or for dependencies on "big" - things, such as the X.org system. In some cases, especially - dependency on toolchain options, it is recommended to add a - +comment+ displayed when the option is not enabled, so that the user - knows why the package is not available. + dependency for dependencies on toolchain options (target + architecture, MMU support, C library, C++ support, large file + support, thread support, RPC support, IPV6 support, WCHAR support), + or for dependencies on "big" things, such as the X.org system. In + some cases, especially dependency on toolchain options, it is + recommended to add a +comment+ displayed when the option is not + enabled, so that the user knows why the package is not available. + The +depends on+ keyword express the dependency with a forward + semantic. + +.Note +The current problem with the _kconfig_ language is that these two +dependency semantics are not internally linked. Therefore, it may be +possible to select a package, whom one of its dependencies/requirement +is not met. An example illustrates both the usage of +select+ and +depends on+. @@ -147,6 +159,9 @@ is also enabled, but not necessarily built before your package. To do so, the dependency also needs to be expressed in the +.mk+ file of the package. +Further formating details: see xref:writing-rules-config-in[the +writing rules]. + The +.mk+ file ^^^^^^^^^^^^^^ @@ -182,8 +197,5 @@ different way, using different infrastructures: CMake. We cover them through a xref:cmake-package-tutorial[tutorial] and xref:cmake-package-reference[reference]. -* *Hand-written Makefiles:* These are currently obsolete, and no new - manual Makefiles should be added. However, since there are still - many of them in the tree, we keep them documented in a - xref:handwritten-tutorial[tutorial]. - +Further formating details: see xref:writing-rules-mk[the writing +rules].