[Buildroot] [PATCH 1 of 2 v2] manual: clarify that Config.in comments should have correct dependencies

Samuel Martin s.martin49 at gmail.com
Thu Nov 7 10:43:41 UTC 2013

2013/11/7 Thomas De Schampheleire <patrickdepinguin at gmail.com>

> Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire at gmail.com>
Acked-by: "Samuel Martin" <s.martin49 at gmail.com>

> ---
> v2:
> - fix typo 'to be expressed' in this section (Samuel)
> - add comment on preferred if...endif construct
>  docs/manual/adding-packages-directory.txt |  17 +++++++++++++++--
>  1 files changed, 15 insertions(+), 2 deletions(-)
> diff --git a/docs/manual/adding-packages-directory.txt
> b/docs/manual/adding-packages-directory.txt
> --- a/docs/manual/adding-packages-directory.txt
> +++ b/docs/manual/adding-packages-directory.txt
> @@ -171,8 +171,9 @@ C library, C++ support, largefile suppor
>  IPv6 support, wchar support, or dynamic library support. Some packages
>  can only be built on certain target architectures, or if an MMU is
>  available in the processor.
> -These dependencies have to expressed with the appropriate 'depends on'
> -statements in the Config.in file. Additionally, for dependencies on
> +
> +These dependencies have to be expressed with the appropriate 'depends
> +on' statements in the Config.in file. Additionally, for dependencies on
>  toolchain options, a +comment+ should be displayed when the option is
>  not enabled, so that the user knows why the package is not available.
>  Dependencies on target architecture or MMU support should not be
> @@ -180,6 +181,18 @@ made visible in a comment: since it is u
>  freely choose another target, it makes little sense to show these
>  dependencies explicitly.
> +The +comment+ should only be visible if the +config+ option itself would
> +be visible when the toolchain option dependencies are met. This means
> +that all other dependencies of the package (including dependencies on
> +target architecture and MMU support) have to be repeated on the
> ++comment+ definition. To keep it clear, the +depends on+ statement for
> +these non-toolchain option should be kept separate from the +depends on+
> +statement for the toolchain options.
> +If there is a dependency on a config option in that same file (typically
> +the main package) it is preferable to have a global +if ... endif+
> +construct rather than repeating the +depends on+ statement on the
> +comment and other config options.
> +
>  The general format of a dependency +comment+ for package foo is:
>  --------------------------
>  foo needs a toolchain w/ featA, featB, featC

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20131107/ac79858b/attachment-0002.html>

More information about the buildroot mailing list