summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Wielaard <mjw@redhat.com>2013-11-04 15:19:32 +0100
committerMark Wielaard <mjw@redhat.com>2013-11-04 15:19:32 +0100
commit018c0344033f2db508ef4e09b4eb07438ef35964 (patch)
tree9957d04e0e4652936ab63ccbdb98fb3b04ee2e81
parent3cf491ee10f10855a49e6a35cc9b8365a3197553 (diff)
downloadelfutils-018c0344033f2db508ef4e09b4eb07438ef35964.tar.gz
README: Document that tools and libraries should be upgraded together.
On some distributions it was possible to upgrade separate parts of elfutils individually. That causes hard to debug issues since some tools (e.g. readelf) and some libraries (e.g. libdw) depend on libelf internal data structures, which could be different between versions (or when configured with different flags). So explicitly document that they should always be upgraded together. Signed-off-by: Mark Wielaard <mjw@redhat.com>
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 33cac74f..138717b3 100644
--- a/README
+++ b/README
@@ -10,3 +10,10 @@ Fundamental design decision:
users must match. No third-party EBL module are supported or allowed.
The only reason there are separate modules is to not have the code for
all architectures in all the binaries.
+
+- although the public libraries (libasm, libdw) have a stable API and are
+ backwards ABI compatbile they, and the elfutils tools, do depend on each
+ others internals, and on internals of libelf to provide their interfaces.
+ So they should always be upgraded in lockstep when packaging the tools
+ and libraries separately. For one example of how to do that, see the
+ config/elfutils.spec.