Tree [r3117] / tags / elftoolchain-0.5.1 /
History



File Date Author Commit
addr2line 2011-11-09 jkoshy [r2118] Use the `EXIT_FAILURE` symbol instead of a nume...
ar 2011-11-10 jkoshy [r2130] Style and portability tweaks for '''ar''':
brandelf 2011-11-09 jkoshy [r2119] Use the `EXIT_FAILURE` symbol instead of a nume...
common 2011-11-10 jkoshy [r2140] Fix a few nits in the build ruleset:
cxxfilt 2011-11-09 jkoshy [r2120] Use the `EXIT_FAILURE` symbol instead of a nume...
documentation 2011-11-10 jkoshy [r2139] Support the use `make clobber` at the root of t...
elfcopy 2011-11-10 jkoshy [r2126] Style tweaks for '''elfcopy''': Use `EXIT_{FAIL...
elfdump 2011-11-10 jkoshy [r2127] Style tweaks for '''elfdump''': use the portabl...
findtextrel 2011-11-09 jkoshy [r2119] Use the `EXIT_FAILURE` symbol instead of a nume...
libdwarf 2011-11-10 jkoshy [r2134] Correctly call `errx()` in the displayed example.
libelf 2011-11-09 jkoshy [r2123] Style tweaks to the `elf_version.3` manual page...
libelftc 2011-11-15 jkoshy [r2171] Merge a fix from `trunk`.
mk 2011-11-10 jkoshy [r2139] Support the use `make clobber` at the root of t...
nm 2011-11-13 jkoshy [r2164] Merge recent changes to '''nm''' to the v0.5 re...
readelf 2011-11-10 jkoshy [r2128] Style tweaks for '''readelf''': use the portabl...
size 2011-11-09 jkoshy [r2124] Portability fixes for '''size''':
strings 2011-11-10 jkoshy [r2129] Portability tweaks for '''strings''':
test 2011-11-10 jkoshy [r2142] Portability fixes to the `ar`, `elfcopy` and `n...
INSTALL 2011-11-11 jkoshy [r2148] Merge changesets [2146] and [2147] from `trunk`:
Makefile 2011-11-10 jkoshy [r2139] Support the use `make clobber` at the root of t...
README 2011-11-12 jkoshy [r2149] Update the top-level `README` to reflect the co...
RELEASE-NOTES 2011-11-13 jkoshy [r2165] Modify the "Test Statistics" section of the rel...

Read Me

The Elftoolchain Project
========================

.. contents::
..

Description
-----------

This software implements essential compilation tools and libraries for:

- managing program objects conforming to the ELF_ object format, and
- for managing DWARF_ debugging information in ELF objects.

The project currently implements the following utilities and
libraries:

    =========== ============================================
    Name        Description
    =========== ============================================
    ar          Archive manager.
    addr2line   Debug tool.
    brandelf    Manage the ELF brand on executables.
    c++filt     Translate encoded symbols.
    elfcopy     Copy and translate between object formats.
    elfdump     Diagnostic tool.
    findtextrel Find undesired text relocations.
    libdwarf    DWARF access library.
    libelf      ELF access library.
    mcs         Manage comment sections.
    nm          List symbols in an ELF object.
    ranlib      Add archive symbol tables to an archive.
    readelf     Display ELF information.
    size        List object sizes.
    strings     Extract printable strings.
    strip       Discard information from ELF objects.
    =========== ============================================

.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
.. _DWARF: http://www.dwarfstd.org/


Project Documentation
---------------------

- Release notes for released versions of this software are present in
  the file ``RELEASE-NOTES`` in the current directory.
- The file ``INSTALL`` in the current directory contains instructions
  on building and installing this software.
- Reference documentation in the form of manual pages is provided for
  the utilities and libraries developed by the project.
- Additional tutorial documentation is present in the
  ``documentation`` directory.


Tracking Ongoing Development
----------------------------

The project uses subversion_ for its version control system.

The subversion branch for the current set of sources may be accessed
at the following URL:

  https://elftoolchain.svn.sourceforge.net/svnroot/elftoolchain/branches/release-branch-0.5

The project's source tree may be checked out from its repository by
using the ``svn checkout`` command::

    % svn checkout https://elftoolchain.svn.sourceforge.net/svnroot/elftoolchain/branches/release-branch-0.5

Checked-out sources may be kept upto-date by running ``svn update``
inside the source directory::

   % svn update


Instructions on building and installing the software are given in the
file ``INSTALL`` in the current directory.

.. _Subversion: 

Downloading Released Software
-----------------------------

Released versions of the project's software may also be downloaded
from SourceForge's `file release system`_.

.. _file release system: http://sourceforge.net/projects/elftoolchain/files/

Copyright and License
---------------------

This code is copyright its authors, and is distributed under the `BSD
License`_.

.. _BSD License: http://www.opensource.org/licenses/bsd-license.php


Developer Community
-------------------

The project's developers may be contacted using the mailing list:
``<elftoolchain-developers@lists.sourceforge.net>``.


Reporting Bugs
--------------

Please use our `Trac instance`_ for viewing existing bug reports and
for submitting new bug reports.

.. _`Trac instance`: http://sourceforge.net/apps/trac/elftoolchain/report


Additional Information
----------------------

Additional information about the project may be found on the `project
website`_.

.. _project website:  http://elftoolchain.sourceforge.net/

.. $Id: README 2149 2011-11-12 05:19:10Z jkoshy $

.. Local Variables:
.. mode: rst
.. End: