blob: 37e45bdfe303e1141aff085a7dcc071c7c464e32 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
.. $Id: RELEASE-NOTES 2599 2012-09-25 06:25:51Z jkoshy $
.. This file contains a template for use when writing release notes.
.. It needs to be updated with release-specific content prior to
.. cutting a release. RST comments (such as this one) also need to be
.. removed prior to the release.
.. The tokens '%.*%' need be replaced with actual content.
Release Notes for Elftoolchain Software Version %.%.%
=====================================================
About The Project
-----------------
The `Elftoolchain project`_ develops BSD-licensed implementations of
essential compilation tools and libraries for handling ELF based program
objects.
About The Release
-----------------
.. Describe the rationale for the release (e.g. new features,
.. significant bug fixes, etc.).
Libraries and Utilities
~~~~~~~~~~~~~~~~~~~~~~~
This release comprises the following libraries and utilities.
================= ==========================================
**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.
================= ==========================================
Documentation
~~~~~~~~~~~~~
Each public API and invocable utility has a reference manual entry.
We currently offer %NENTRIES% manual entries, documented in %NFILES%
manual pages.
Additionally, this release contains the following documentation:
================= ==========================================
**Name** **Description**
================= ==========================================
libelf-by-example A tutorial introduction to **libelf**.
================= ==========================================
Test Suites
~~~~~~~~~~~
The release contains the following test suites:
================= ==========================================
**Name** **Description**
================= ==========================================
ar Test the **ar** utility.
elfcopy Test the **elfcopy** utility.
elfdump Test the **elfdump** utility.
libdwarf Test the **libdwarf** library.
libelf Test the **libelf** library.
nm Test the **nm** utility.
================= ==========================================
System Requirements
-------------------
.. Hardware and software requirements for using this software.
This software is designed to run on Unix(TM)-like operating systems
such as the BSD-family of operating systems and GNU/Linux.
This release has been built and tested on the following operating
systems:
==================== =========== ===========================
**Operating System** **Version** **Supported Architectures**
-------------------- ----------- ---------------------------
`DragonFly BSD`_ 2.10.1 i386
FreeBSD_ v8.2 amd64 & i386
Minix_ 3.2.0 i386
NetBSD_ v5.0.2 i386
OpenBSD_ v5.0 i386
Ubuntu_ GNU/Linux 10.04LTS i386 & x86_64
==================== =========== ===========================
Installation and Upgrades
=========================
Installation
------------
Instructions for building and installing this software from source are
described in the file "INSTALL".
Upgrading
---------
.. Special notes about upgrading this software from a prior release.
.. For example, if we introduce any backwards-incompatible behaviour,
.. or if we deprecate existing behaviour.
Release Information
===================
Changes in this release
-----------------------
.. A list of significant changes in the release.
Outstanding Issues
------------------
.. Problems discovered when testing the release.
Known Limitations
-----------------
.. Known limitations.
Test Statistics
---------------
The test summary for this release is presented below:
========= ========= ================ =============== ================ ===================
**Suite** **Tests** **DragonFlyBSD** **FreeBSD** **NetBSD** **Ubuntu 10.04LTS**
========= ========= ================ =============== ================ ===================
ar
elfcopy
elfdump
libdwarf
libelf
nm
========= ========= ================ =============== ================ ===================
Key:
:P:
Test successes.
:F:
Test failures.
:U:
Unresolved tests.
Notes
~~~~~
More Information
================
The project's website is at http://elftoolchain.sourceforge.net/.
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.
Copyright and License
=====================
This software is copyright its authors, and is distributed under the
`BSD License`_.
.. _BSD License: http://www.opensource.org/licenses/bsd-license.php
.. _DragonFly BSD: http://www.dragonflybsd.org/
.. _Elftoolchain project: http://elftoolchain.sourceforge.net/
.. _FreeBSD: http://www.freebsd.org/
.. _Minix: http://www.minix3.org/
.. _NetBSD: http://www.netbsd.org/
.. _OpenBSD: http://www.openbsd.org/
.. _`Trac instance`: http://sourceforge.net/apps/trac/elftoolchain/report
.. _Ubuntu: http://www.ubuntu.com/
.. Local Variables:
.. mode: rst
.. End:
|
