[Buildroot] [PATCH v7 1/8] support/scripts/check-host-rpath: document existing functions

[Yann E. MORIN <yann.morin.1998@free.fr>]

Thomas, All,

On 2018-12-28 11:43 +0100, Thomas Petazzoni spake thusly:
> As suggested by Arnout Vandecappelle, let's document the
> elf_needs_rpath() and check_elf_has_rpath() functions, before we make
> them a bit more complicated with per-package directory support.
> 
> Suggested-by: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
> Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
> ---
>  support/scripts/check-host-rpath | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/support/scripts/check-host-rpath b/support/scripts/check-host-rpath
> index 6c5767da05..c8939569e2 100755
> --- a/support/scripts/check-host-rpath
> +++ b/support/scripts/check-host-rpath
> @@ -39,6 +39,11 @@ is_elf() {
>      |grep -E 'Requesting program interpreter:' >/dev/null 2>&1
>  }
>  
> +# This function tells whether a given ELF executable (first argument)
> +# needs a RPATH pointing to the host library directory or not. It
> +# needs such an RPATH if at least of the libraries used by the ELF
                                   ^^^
Missing 'one', i.e.:  ... at least one of the libraries...

Reviewed-by: "Yann E. MORIN" <yann.morin.1998@free.fr>

Regards,
Yann E. MORIN.

> +# executable is available in the host library directory. This function
> +# returns 0 when a RPATH is needed, 1 otherwise.
>  elf_needs_rpath() {
>      local file="${1}"
>      local hostdir="${2}"
> @@ -54,6 +59,13 @@ elf_needs_rpath() {
>      return 1
>  }
>  
> +# This function checks whether at least one of the RPATH of the given
> +# ELF executable (first argument) properly points to the host library
> +# directory (second argument), either through an absolute RPATH or a
> +# relative RPATH. Having such a RPATH will make sure the ELF
> +# executable will find at runtime the shared libraries it depends
> +# on. This function returns 0 when a proper RPATH was found, or 1
> +# otherwise.
>  check_elf_has_rpath() {
>      local file="${1}"
>      local hostdir="${2}"
> -- 
> 2.20.1
> 

-- 
.-----------------.--------------------.------------------.--------------------.
|  Yann E. MORIN  | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: |
| +33 662 376 056 | Software  Designer | \ / CAMPAIGN     |  ___               |
| +33 223 225 172 `------------.-------:  X  AGAINST      |  \e/  There is no  |
| http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL    |   v   conspiracy.  |
'------------------------------^-------^------------------^--------------------'