[libcamera-devel] README: Document dependencies for backtrace generation

14160 diff mbox series

libcamera now has the ability to use libdw and libunwind to generate
backtraces, in addition to the glibc backtrace() function. libdw
provides the most detailed output and is highly recommended, but is
limited to parsing backtraces, it doesn't support capturing them.
libunwind and backtrace() provide both features. If backtrace() is
available, libunwind will not bring any improvement.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 README.rst | 8 ++++++++
 1 file changed, 8 insertions(+)


base-commit: 2f75a7e5b8c6258dc12e9e3128cb30133f66b4f9
prerequisite-patch-id: a2501788e3af4ef5a091e784838d614c59e5d7fc
prerequisite-patch-id: 50f1d9ef74d51440b0f79116eb82580ad1fa04a2
prerequisite-patch-id: 6ad689b8c9be17165b330a16c7cef62dbdfb5d8f

Hi Laurent,

On Mon, Oct 18, 2021 at 07:52:26AM +0300, Laurent Pinchart wrote:
> libcamera now has the ability to use libdw and libunwind to generate
> backtraces, in addition to the glibc backtrace() function. libdw
> provides the most detailed output and is highly recommended, but is
> limited to parsing backtraces, it doesn't support capturing them.
> libunwind and backtrace() provide both features. If backtrace() is
> available, libunwind will not bring any improvement.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  README.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/README.rst b/README.rst
> index 9ad0823d2038..8af5f1184e5f 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -63,6 +63,14 @@ for the libcamera core: [required]
>  for IPA module signing: [required]
>          libgnutls28-dev openssl
>  
> +for improved debugging: [optional]
> +        libdw-dev libunwind-dev
> +
> +        libdw and libunwind provide backtraces to help debugging assertion
> +        failures. Their functions overlap, libdw provides the most detailed
> +        information, and libunwind is not needed if both libdw and the glibc
> +        backtrace() function are available.
> +
>  for the Raspberry Pi IPA: [optional]
>          libboost-dev
>  
> 
> base-commit: 2f75a7e5b8c6258dc12e9e3128cb30133f66b4f9
> prerequisite-patch-id: a2501788e3af4ef5a091e784838d614c59e5d7fc
> prerequisite-patch-id: 50f1d9ef74d51440b0f79116eb82580ad1fa04a2
> prerequisite-patch-id: 6ad689b8c9be17165b330a16c7cef62dbdfb5d8f
> -- 
> Regards,
> 
> Laurent Pinchart
>

Hi Laurent,

Thank you for the patch

On 10/18/21 10:22 AM, Laurent Pinchart wrote:
> libcamera now has the ability to use libdw and libunwind to generate
> backtraces, in addition to the glibc backtrace() function. libdw
> provides the most detailed output and is highly recommended, but is
> limited to parsing backtraces, it doesn't support capturing them.
> libunwind and backtrace() provide both features. If backtrace() is
> available, libunwind will not bring any improvement.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>


Reviewed-by: Umang Jain<umang.jain@ideasonboard.com>

> ---
>   README.rst | 8 ++++++++
>   1 file changed, 8 insertions(+)
>
> diff --git a/README.rst b/README.rst
> index 9ad0823d2038..8af5f1184e5f 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -63,6 +63,14 @@ for the libcamera core: [required]
>   for IPA module signing: [required]
>           libgnutls28-dev openssl
>   
> +for improved debugging: [optional]
> +        libdw-dev libunwind-dev
> +
> +        libdw and libunwind provide backtraces to help debugging assertion
> +        failures. Their functions overlap, libdw provides the most detailed
> +        information, and libunwind is not needed if both libdw and the glibc
> +        backtrace() function are available.
> +
>   for the Raspberry Pi IPA: [optional]
>           libboost-dev
>   
>
> base-commit: 2f75a7e5b8c6258dc12e9e3128cb30133f66b4f9
> prerequisite-patch-id: a2501788e3af4ef5a091e784838d614c59e5d7fc
> prerequisite-patch-id: 50f1d9ef74d51440b0f79116eb82580ad1fa04a2
> prerequisite-patch-id: 6ad689b8c9be17165b330a16c7cef62dbdfb5d8f