summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-10-13 00:32:08 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-10-19 13:14:54 +0300
commit78e94065fca63bfc3d00e77928554a440cd493a3 (patch)
treef727ef43bc3a6cc76bc3ce26e6db06acdfffe457
parent5b39dc6d9bf61c23e743dd97d527c1eb2bd41aee (diff)
README: Document dependencies for backtrace generation
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> Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
-rw-r--r--README.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 9ad0823d..8af5f118 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