Re: [ptxdist] [PATCH v6 3/5] scripts: add helper to inject files into a source directory

[Alexander Dahl <ada@thorsis.com>]

Hei hei,

sorry for digging up this old discussion, but I kind of want to use this 
approach and … see below.

Am Samstag, 29. Januar 2022, 08:03:28 CEST schrieb Michael Riesch:
> Some packages may require certain files that are maintained
> or generated outside of their source repository. For example,
> binary firmware blobs could be excluded from the sources due
> to licensing issues. Add a helper that allows to inject certain
> files into the source directory (usually in the prepare stage).

Currently trying to build recent U-Boot for i.MX8 and i.MX9 based boards which 
require additional firmware.  However I still want to build OOT to keep my 
source tree clean, especially when building with an external tree (after 
`ptxdist local-src u-boot $HOME/src/u-boot`).

Now U-Boot needs those binaries in the build tree, it does not work using this 
nice inject mechanism putting it in the source tree.

> 
> Signed-off-by: Michael Riesch <michael.riesch@wolfvision.net>
> ---
> 
> Notes:
>     v6:
>     - replaced 'break' with 'return'
> 
>  rules/post/ptxd_make_world_inject.make | 19 ++++++++++++
>  scripts/lib/ptxd_make_world_inject.sh  | 42 ++++++++++++++++++++++++++
>  2 files changed, 61 insertions(+)
>  create mode 100644 rules/post/ptxd_make_world_inject.make
>  create mode 100644 scripts/lib/ptxd_make_world_inject.sh
> 
> diff --git a/rules/post/ptxd_make_world_inject.make
> b/rules/post/ptxd_make_world_inject.make new file mode 100644
> index 000000000..b7d28e92f
> --- /dev/null
> +++ b/rules/post/ptxd_make_world_inject.make
> @@ -0,0 +1,19 @@
> +# -*-makefile-*-
> +#
> +# Copyright (C) 2021 by Michael Riesch <michael.riesch@wolfvision.net>
> +#
> +# For further information about the PTXdist project and license conditions
> +# see the README file.
> +#
> +
> +world/inject/env = \
> +	$(call world/env, $(1)) \
> +	pkg_inject_path="$($(1)_INJECT_PATH)" \
> +	pkg_inject_files="$($(1)_INJECT_FILES)" \
> +	pkg_source="$($(1)_DIR)"

Here <PKG>_DIR is assigned to pkg_source which makes the source dir the target 
folder.

Did anyone already think of how to extend this approach to be more flexible 
for the target folder?  Maybe even without damaging existing use cases?

Maybe adding a new optional variable <PKG>_INJECT_DEST which defaults to 
<PKG>_DIR and can be overridden?

Greets
Alex

> +
> +world/inject = \
> +	$(call world/inject/env,$(strip $(1))) \
> +	ptxd_make_world_inject
> +
> +# vim: syntax=make
> diff --git a/scripts/lib/ptxd_make_world_inject.sh
> b/scripts/lib/ptxd_make_world_inject.sh new file mode 100644
> index 000000000..fe4eb8363
> --- /dev/null
> +++ b/scripts/lib/ptxd_make_world_inject.sh
> @@ -0,0 +1,42 @@
> +#!/bin/bash
> +#
> +# Copyright (C) 2021 by Michael Riesch <michael.riesch@wolfvision.net>
> +#
> +# For further information about the PTXdist project and license conditions
> +# see the README file.
> +#
> +
> +ptxd_make_inject() {
> +    local source target
> +
> +    source="$(echo ${inject_file} | cut -d ":" -f 1)"
> +    target="${pkg_source}/$(echo ${inject_file} | cut -d ":" -f 2)"
> +    if [ -z "${target}" ]; then
> +	target="${source}"
> +    fi
> +
> +    if [[ "${source}" =~ ^/.* ]]; then
> +	ptxd_bailout "'${source}' must not be an absolute path!" \
> +	    "Use <PKG>_INJECT_PATH to specify the search path."
> +    fi
> +
> +    if ! ptxd_in_path pkg_inject_path "${source}"; then
> +	ptxd_bailout "Blob '${source}' not found in '${pkg_inject_path}'."
> +    fi
> +    source="${ptxd_reply}"
> +
> +    echo -e "\nInject file $(ptxd_print_path ${source}) into" \
> +	 "$(ptxd_print_path ${target})..."
> +    cp ${source} ${target}
> +}
> +export -f ptxd_make_inject
> +
> +
> +ptxd_make_world_inject() {
> +    ptxd_make_world_init || return
> +
> +    for inject_file in ${pkg_inject_files}; do
> +	ptxd_make_inject || return
> +    done
> +}
> +export -f ptxd_make_world_inject