Re: [Buildroot] [PATCH 1/2] docs/manual: describe relying on default options

[Thomas Petazzoni via buildroot <buildroot@buildroot.org>]

On Fri,  5 Jul 2024 11:44:48 +0200
Fiona Klute via buildroot <buildroot@buildroot.org> wrote:

> From: "Fiona Klute (WIWA)" <fiona.klute@gmx.de>
> 
> People can assume that e.g. Busybox options enabled in the package are
> enabled when writing code for Buildroot. Anyone who uses custom
> configurations that disable default options needs to make sure
> relevant scripts etc. still work for themselves.
> 
> Signed-off-by: Fiona Klute (WIWA) <fiona.klute@gmx.de>
> ---
>  docs/manual/integration-principles.adoc | 18 ++++++++++++++++++
>  docs/manual/integration.adoc            |  2 ++
>  2 files changed, 20 insertions(+)
>  create mode 100644 docs/manual/integration-principles.adoc
> 
> diff --git a/docs/manual/integration-principles.adoc b/docs/manual/integration-principles.adoc
> new file mode 100644
> index 0000000000..9e2f43a18a
> --- /dev/null
> +++ b/docs/manual/integration-principles.adoc
> @@ -0,0 +1,18 @@
> +// -*- mode:doc; -*-
> +// vim: set syntax=asciidoc:
> +
> +[[integration-principles]]
> +=== Integration Principles
> +
> +Some foundational packages like Busybox can be configured with or
> +without certain features. When writing Buildroot code that uses such
> +packages, contributors may assume that the options enabled in the
> +Buildroot-provided configurations are enabled. For example,
> ++package/busybox/busybox.config+ sets
> ++CONFIG_FEATURE_START_STOP_DAEMON_LONG_OPTIONS=y+, so init scripts
> +meant for use with Busybox init may use +start-stop-daemon+ with long
> +form options.
> +
> +People who use custom configurations that disable such default options
> +are responsible for making sure that all relevant scripts still work,
> +and if not, adapting them accordingly (in an overlay).

I understand the wish to document this, but I'm not sure an
"Integration principles" is the right place. Shouldn't we document that
in a section where we document the expectations in terms of init
scripts instead?

Best regards,

Thomas
-- 
Thomas Petazzoni, co-owner and CEO, Bootlin
Embedded Linux and Kernel engineering and training
https://bootlin.com
_______________________________________________
buildroot mailing list
buildroot@buildroot.org
https://lists.buildroot.org/mailman/listinfo/buildroot