added a disabled stub for complex float support
[platform/upstream/ltrace.git] / README
diff --git a/README b/README
index ab1a2e5..a04b767 100644 (file)
--- a/README
+++ b/README
-                                ltrace
+This directory contains sources of ltrace.  See the file configure.ac
+to see what version this is.
 
-                       A Dynamic Library Tracer
+Ltrace is a debugging program which runs a specified command until the
+command exits.  While the command is executing, ltrace intercepts and
+records both the dynamic library calls called by the executed process
+and the signals received by the executed process.  Ltrace can also
+intercept and print system calls executed by the process.
 
-         Copyright 1997-2009 Juan Cespedes <cespedes@debian.org>
+For general building and installation instructions, see the file INSTALL.
 
+For list of authors and contributors, see the file CREDITS.
 
-Contents
---------
- 0. Authors
- 1. Introduction
- 2. Where can I find it
- 3. How does it work
- 4. Where does it work
- 5. Bugs
- 6. License
+ltrace is free software.  See the file COPYING for license.
 
+Some documentation on ltrace usage is given in the manual page, which
+is in the file ltrace.1.
 
-0. Authors
-----------
 
-ltrace has been developed mainly by Juan Cespedes <cespedes@debian.org>,
-but he has received many contributions from other people.  The following
-people have contributed significantly to this project:
+Supported Targets
+-----------------
 
-* César Sánchez <cesar.sanchez@imdea.org>
-* Santiago Romero <santiago.romero@imdea.org>
-* Pat Beirne <pbeirne@home.com> (ARM port)
-* Roman Hodek <Roman.Hodek@informatik.uni-erlangen.de> (m68k port)
-* Morten Eriksen <mortene@sim.no> (misc fixes)
-* Silvio Cesare <silvio@big.net.au> (ELF hacking)
-* Timothy Fesig <slate@us.ibm.com> (S390 port)
-* Anton Blanchard <anton@samba.org> (Powerpc port)
-* Jakub Jelinek <jakub@redhat.com> (SPARC port, support for libelf, many fixes)
-* Jakub Bogusz <qboosh@pld-linux.org> (alpha port)
-* SuSE (amd64 port)
-* Ian Wienand <ianw@gelato.unsw.edu.au> (IA64 port)
-* Eric Vaitl <evaitl@cisco.com> (mipsel port)
-* Petr Machata <pmachata@redhat.com> (misc fixes)
+The following targets are currently (at least somewhat) supported.
+Some of them may be more or less broken in reality, it is not feasible
+to test each release comprehensively on each target.
 
-1. Introduction
----------------
+       aarch64-*-linux-gnu
+       armv6l-*-linux-gnueabi
+       armv7l-*-linux-gnueabihf
+       i[4567]86-*-linux-gnu
+       ia64-*-linux-gnu
+       m68k-*-linux-gnu
+       metag-*-linux-uclibc
+       mips-*-linux-gnu
+       powerpc-*-linux-gnu
+       powerpc64-*-linux-gnu
+       s390-*-linux-gnu
+       s390x-*-linux-gnu
+       x86_64-*-linux-gnu
 
-ltrace is a debugging tool, similar to strace, but it traces library
-calls instead of system calls.
+The following systems were supported at some point in past, but
+current status is unknown:
 
-2. Where can I find it
-----------------------
+       sparc*-*-linux-gnu
+       sparc64*-*-linux-gnu
+       alpha*-*-linux-gnu
 
-http://www.ltrace.org
 
-3. How does it work
--------------------
+Bug Reports
+-----------
 
-Using software breakpoints, just like gdb.
+You can send bug reports to <ltrace-devel@lists.alioth.debian.org>.
+User requests can also be directed to that address.
 
-4. Where does it work
----------------------
+If the ltrace package that you are using came with your operating
+system, please be sure to reproduce the problem in unmodified upstream
+version of ltrace before reporting a bug.
 
-It works with ELF based Linux systems running on i386, m68k, S/390,
-ARM, PowerPC, PowerPC64, IA64, AMD64, SPARC and Alpha processors.
 
-It is part of at least Debian GNU/Linux, RedHat, SuSE, Mandrake...
+Development
+-----------
 
-5. Bugs
--------
+ltrace development is hosted by Alioth.Debian.org:
 
-Too many to list here :).  If you like to submit a bug report, or a
-feature request, either do that against the Debian `ltrace' package,
-or mail ltrace-devel@lists.alioth.debian.org.
+  https://alioth.debian.org/projects/ltrace/
 
-This file is very incomplete and out-of-date.
+Release tarballs can be downloaded here:
 
-6. License
-----------
+  https://alioth.debian.org/frs/?group_id=30892
 
-    Copyright (C) 1997-2009 Juan Cespedes <cespedes@debian.org>
+Anonymous GIT access is available via:
 
-    This program is free software; you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation; either version 2 of the License, or
-    (at your option) any later version.
+  git://git.debian.org/git/collab-maint/ltrace.git
 
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
+If you have anything to contribute, please send an e-mail to
+<ltrace-devel@lists.alioth.debian.org>, and attach your patches
+formatted with git format-patch.  This makes them easy to apply after
+review, and such patches also preserve authorship.
 
-    You should have received a copy of the GNU General Public License along
-    with this program; if not, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+If you intend to work on a feature (essentially anything beyond a
+quick one-liner), it is advisable to send an e-mail beforehand.
 
+
+-------------------------------------------------------------------------------
+Copyright (C) 2012-2014 Petr Machata <pmachata@redhat.com>
+Copyright (C) 1997-2009 Juan Cespedes <cespedes@debian.org>
+This file is part of ltrace.
+
+ltrace is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your
+option) any later version.
+
+ltrace is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.