freebsd

mirror of https://git.FreeBSD.org/src.git synced 2024-11-30 08:19:09 +00:00

History

Ed Maste ea444392bb readelf: return error in case of invalid file GNU readelf exits with an error for a number of invalid file cases. Previously ELF Tool Chain readelf always exited with 0. Now we exit 1 upon detecting an error with one or more input files, but in any case all of them are processed. This should catch common failure cases. We still do not report an error for some types of malformed ELF files, but this is consistent with GNU readelf. PR: 252727 Reviewed by: jkoshy, markj MFC after: 1 week Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D29377		2021-04-04 21:01:28 -04:00
..
addr2line	addr2line: fix allocation leak in error path	2020-12-03 14:41:11 +00:00
ar	Update to ELF Tool Chain r3668	2019-01-10 14:35:23 +00:00
brandelf	Use the in-tree sys/elf_common.h to build libelftc.	2016-06-05 23:05:14 +00:00
common	Update ELF Tool Chain to upstream r3769	2019-12-05 13:20:15 +00:00
cxxfilt	Capsicumize c++filt(1).	2019-09-30 16:10:42 +00:00
elfcopy	elftoolchain: stop leaving tempfiles on error	2021-03-04 12:24:07 +00:00
elfdump	Update ELF Tool Chain to upstream r3769	2019-12-05 13:20:15 +00:00
libdwarf	libdwarf: Hide SHT_NOBITS sections.	2020-07-20 18:22:38 +00:00
libelf	elftoolchain: Support building on Arm-based Macs	2021-03-20 17:58:10 +00:00
libelftc	Merge elftoolchain r3877 (by jkoshy):	2020-11-04 11:02:05 +00:00
libpe	libpe: Avoid a potential use-after-free in pe_update_symtab().	2020-03-20 16:24:23 +00:00
nm	Update ELF Tool Chain to upstream r3769	2019-12-05 13:20:15 +00:00
readelf	readelf: return error in case of invalid file	2021-04-04 21:01:28 -04:00
size	size: Avoid returning a stack pointer from xlatetom().	2020-02-04 21:17:59 +00:00
strings	strings: extends rights	2019-07-16 04:17:25 +00:00
.cirrus.yml	Update ELF Tool Chain to upstream r3769	2019-12-05 13:20:15 +00:00
README.rst	Update ELF Tool Chain to upstream r3769	2019-12-05 13:20:15 +00:00

README.rst

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

.. contents:: Table of 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.

.. _subversion: https://subversion.apache.org/

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

    https://sourceforge.net/p/elftoolchain/code/HEAD/tree/trunk/

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

    % svn checkout https://svn.code.sf.net/p/elftoolchain/code/trunk

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.

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 `bug tracker`_ for viewing existing bug reports and
for submitting new bug reports.

.. _`bug tracker`: https://sourceforge.net/p/elftoolchain/tickets/


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

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

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

.. $Id: README.rst 3677 2019-02-11 09:37:09Z jkoshy $

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