Buildroot Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Samuel Martin <s.martin49@gmail.com>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH 09/23] manual: adding-package-directory.txt: update, cleanup and typo fixes
Date: Sun, 11 Nov 2012 14:14:47 +0100	[thread overview]
Message-ID: <1352639701-27829-10-git-send-email-s.martin49@gmail.com> (raw)
In-Reply-To: <1352639701-27829-1-git-send-email-s.martin49@gmail.com>


Signed-off-by: Samuel Martin <s.martin49@gmail.com>

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].
-- 
1.8.0

  parent reply	other threads:[~2012-11-11 13:14 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-11 13:14 [Buildroot] [PATCH 00/23] Pull request for branch for-2012/doc Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 01/23] dependencies.sh: remove makeinfo (texinfo) from the requirement list Samuel Martin
2012-11-11 17:10   ` Thomas Petazzoni
2012-11-15 23:00     ` Peter Korsgaard
2012-11-11 13:14 ` [Buildroot] [PATCH 02/23] manual: make clean target consistent with others in buildroot Samuel Martin
2012-11-11 22:57   ` Arnout Vandecappelle
2012-11-11 23:34     ` Samuel Martin
2012-11-15 21:56       ` Peter Korsgaard
2012-11-15 22:07         ` Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 03/23] manual: set toc depth to 4 for html outputs Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 04/23] manual: rework the whole documentation stub Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 05/23] manual: rework introduction.txt and add embedded-basics.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 06/23] manual: rework using.txt and update common-usage.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 07/23] manual: customize-rootfs.txt: refactoring, misc. fixes and update Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 08/23] manual: update rebuilding-packages.txt Samuel Martin
2012-11-11 13:14 ` Samuel Martin [this message]
2012-11-11 13:14 ` [Buildroot] [PATCH 10/23] manual: add prerequisite.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 11/23] manual: add make-tips.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 12/23] manual: faq.txt: rework and update Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 13/23] manual: add writing-rules.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 14/23] manual: add get-involved.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 15/23] manual: add contribute.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 16/23] manual: add package-make-target.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 17/23] manual: add download-infra.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 18/23] manual: add patch-policy.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 19/23] manual: add adding-package-tips.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 20/23] manual: add legal-info.txt Samuel Martin
2012-11-11 13:14 ` [Buildroot] [PATCH 21/23] manual: add pkg-list.txt (generated list of available packages) Samuel Martin
2012-11-11 23:11   ` Arnout Vandecappelle
2012-11-11 13:15 ` [Buildroot] [PATCH 22/23] manual: add deprecated-list.txt Samuel Martin
2012-11-11 13:15 ` [Buildroot] [PATCH 23/23] manual: add beyond-buildroot.txt Samuel Martin
2012-11-11 13:23 ` [Buildroot] [PATCH 00/23] Pull request for branch for-2012/doc Samuel Martin
2012-11-11 23:13   ` Arnout Vandecappelle
2012-11-15 23:01   ` Peter Korsgaard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1352639701-27829-10-git-send-email-s.martin49@gmail.com \
    --to=s.martin49@gmail.com \
    --cc=buildroot@busybox.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox