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