summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMark Wielaard <mark@klomp.org>2016-12-24 22:31:41 +0100
committerMark Wielaard <mark@klomp.org>2016-12-24 22:51:32 +0100
commit1700fd25e6caf26663af2bd994d1d99fab9df59f (patch)
tree9a0bb382900e622e39e876b85c07e485d2b5c86b /README
parent0d0f8450ffc6135c0938308254f378ac79612e75 (diff)
http://elfutils.org/ is now hosted at http://sourceware.org/elfutils/
fedorahosted used to be our home, but we are now hosted at sourceware. Change the elfutils project home to http://elfutils.org/ Point hosted services (email, release, git, bug tracker and web pages) to https://sourceware.org/elfutils/ Move design notes from README to NOTES. Add URLs for home, releases, bugs, git and mailinglist to README. Make the --version output of all tools the same by using a common print_version function and update the publicly shown copyright holder to the elfutils developers. Signed-off-by: Mark Wielaard <mark@klomp.org>
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 22 insertions, 19 deletions
diff --git a/README b/README
index 35646766..9e55d75a 100644
--- a/README
+++ b/README
@@ -1,19 +1,22 @@
-Fundamental design decision:
-
-- the sizes of external and internal types are assumed to be the same.
- This leaves byte ordering aside. While assuming this the code can be
- greatly simplified and speed increases. Since no change violating this
- assumption is in sight this is believed to be a worthwhile optimization.
-
-- the ABI of the backend modules is not guaranteed. Really, no guarantee
- whatsoever. We are enforcing this in the code. The modules and their
- 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 compatible 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.
+The elfutils project provides libraries and tools for ELF files and DWARF data.
+
+The project home is http://elfutils.org/
+
+Releases are published at ftp://sourceware.org/pub/elfutils/
+Which can also be found at https://sourceware.org/elfutils/ftp/
+
+Please reports bugs at https://sourceware.org/bugzilla/
+
+The current elfutils source code can be checked out with
+git clone git://sourceware.org/git/elfutils.git
+
+The developer mailinglist to send patches to is
+elfutils-devel@sourceware.org.
+https://sourceware.org/ml/elfutils-devel/
+
+To subscribe send an email to elfutils-devel-subscribe@sourceware.org
+Or use the form at https://sourceware.org/lists.html#ml-requestor
+
+See the CONTRIBUTING file for how to propose patches to the code.
+
+See the NOTES files for some design decisions and notes.