RubyGems - ruby-elf - Versions diffs - 1.0.7 → 1.0.8 - Mend

ruby-elf 1.0.7 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/README.md +64 -0
data/lib/elf.rb +1 -1
data/ruby-elf.gemspec +29 -0
metadata +38 -74
data/bin/cowstats +0 -266
data/bin/elfgrep +0 -246
data/bin/missingstatic +0 -113
data/bin/rbelf-nm +0 -113
data/bin/rbelf-read +0 -146
data/bin/rbelf-size +0 -184
data/bin/verify-lfs +0 -125
data/extras/README.extras +0 -5
data/extras/bindings-parsers.rb +0 -157
data/manpages/cowstats.1.xml +0 -234
data/manpages/elfgrep.1.xml +0 -423
data/manpages/missingstatic.1.xml +0 -290
data/manpages/rbelf-nm.1.xml +0 -339
data/manpages/rbelf-size.1.xml +0 -345
data/manpages/verify-lfs.1.xml +0 -136
data/tools/link-collisions/known-broken +0 -154
data/tools/link-collisions/multimplementations +0 -170
data/tools/link-collisions/suppressions +0 -287

data/manpages/missingstatic.1.xml DELETED

@@ -1,290 +0,0 @@
-<?xml version='1.0'?>
-<!--
-Copyright © 2008-2011, Diego Elio Pettenò <flameeyes@flameeyes.eu>
-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.
-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.
-You should have received a copy of the GNU General Public License
-along with this generator; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
--->
-<article xmlns="http://docbook.org/ns/docbook"
-         xmlns:xl="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         version="5.0" xml:lang="en">
-  <info>
-    <title>missingstatic</title>
-    <xi:include parse="xml" href="author.xmli" />
-  </info>
-  <section>
-    <title>Reference</title>
-    <refentry>
-      <info>
-        <date>October 2008</date>
-        <productname>ruby-elf</productname>
-      </info>
-      <refmeta>
-        <refentrytitle>missingstatic</refentrytitle>
-        <manvolnum>1</manvolnum>
-      </refmeta>
-      <refnamediv>
-        <refname>missingstatic</refname>
-        <refpurpose>ELF analyzer to identify missing static modifiers</refpurpose>
-      </refnamediv>
-      <refsynopsisdiv>
-        <cmdsynopsis>
-          <command>missingstatic</command>
-          <arg choice="opt"><option>--hidden-only</option></arg>
-          <arg choice="opt"><option>--show-type</option></arg>
-          <arg choice="opt">
-            <option>--exclude-regexp</option>
-            <replaceable>regular-expression</replaceable>
-          </arg>
-          <arg choice="opt">
-            <option>--exclude-tags</option>
-            <replaceable>tags-file</replaceable>
-          </arg>
-          <xi:include href="common.xmli"  xpointer="xpointer(id('filelist.synopsis')/*)" />
-        </cmdsynopsis>
-      </refsynopsisdiv>
-      <refsect1>
-        <title>Description</title>
-        <para>
-          <command>missingstatic</command> is a script that analyses ELF object files to identify
-          symbols that are unused outside their compilation unit. Those symbols are usually
-          candidate for the <constant>static</constant> modifier, to make the symbol local to the
-          unit.
-        </para>
-        <para>
-          In addition to symbols that are used only internally to an unit, this script will most
-          likely report the almost entire set of externally-visible API in the case of
-          libraries. For this reason, options are provided to reduce the scope of action.
-        </para>
-      </refsect1>
-      <refsect1>
-        <title>Options</title>
-        <variablelist>
-          <varlistentry>
-            <term><option>-h</option></term>
-            <term><option>--hidden-only</option></term>
-            <listitem>
-              <para>
-                Only show symbols that have hidden visibility. Hidden symbols are not visible from
-                outside the module, and thus will ignore the external visible symbols that compose
-                the externally-visible API. This option is only useful for libraries that make
-                proper use of visibility attributes.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><option>-t</option></term>
-            <term><option>--show-type</option></term>
-            <listitem>
-              <para>
-                Show the type of the symbol. The symbols reported by the script might be functions,
-                variables, or constants. By default, only the name of the symbol, with this option,
-                a letter in front of the symbol will tell you the type of it; the letters are the
-                same as used by GNU
-                <citerefentry><refentrytitle>nm</refentrytitle><manvolnum>1</manvolnum></citerefentry>:
-                <variablelist>
-                  <varlistentry>
-                    <term>T</term>
-                    <listitem>
-                      <para>
-                        The symbol is in the text (code) section, and is thus a function
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                  <varlistentry>
-                    <term>B</term>
-                    <listitem>
-                      <para>
-                        The symbol is in the uninitialised data section (known as BSS), and is thus
-                        a variable.
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                  <varlistentry>
-                    <term>D</term>
-                    <listitem>
-                      <para>
-                        The symbol is in the initialised data section, and is thus a variable.
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                  <varlistentry>
-                    <term>R</term>
-                    <listitem>
-                      <para>
-                        The symbol is in the read only data section, and is thus a constant.
-                      </para>
-                    </listitem>
-                  </varlistentry>
-                </variablelist>
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term>
-              <option>-x</option>
-              <replaceable>regular-expression</replaceable>
-            </term>
-            <term>
-              <option>--exclude-regexp</option>
-              <replaceable>regular-expression</replaceable>
-            </term>
-            <listitem>
-              <para>
-                Ignore symbols whose name triggers the given regular expression. This option is
-                useful to hide all the symbols of the public API of a library if they all have the
-                same prefix. It can be used multiple times.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term>
-              <option>-X</option>
-              <replaceable>tags-file</replaceable>
-            </term>
-            <term>
-              <option>--exclude-tags</option>
-              <replaceable>tags-file</replaceable>
-            </term>
-            <listitem>
-              <para>
-                Ignore symbols present in a tags file created by
-                <command>exuberant-ctags</command>. This option is useful to hide all the symbols in
-                the public header files of a project, by creating a list of public-visible
-                symbols. See the <link linkend="examples">EXAMPLES</link> section for how to
-                generate such a tags file.  It can be used multiple times.
-              </para>
-            </listitem>
-          </varlistentry>
-          <xi:include href="common.xmli" xpointer="xpointer(id('filelist.option')/*)" />
-        </variablelist>
-      </refsect1>
-      <refsect1 xml:id="examples">
-        <title>Examples</title>
-        <refsect2>
-          <title>Generating the tags file</title>
-          <para>
-            To generate a tags file compatible with the <option>--exclude-tags</option> command-line
-            option, you can use
-            <citerefentry>
-              <refentrytitle>exuberant-ctags</refentrytitle>
-              <manvolnum>1</manvolnum>
-            </citerefentry>
-            with a command similar to the following:
-          </para>
-          <example>
-            <title>
-              Generate a tags file for public header files
-            </title>
-            <programlisting>
-              exuberant-ctags --c-kinds=px -f public-symbols include/public/*.h
-            </programlisting>
-          </example>
-        </refsect2>
-        <refsect2>
-          <title>Sorting <command>missingstatic</command> output</title>
-          <para>
-            Since sorting by translation unit is non-trivial inside the script, piping through
-            <citerefentry>
-              <refentrytitle>sort</refentrytitle>
-              <manvolnum>1</manvolnum>
-            </citerefentry>
-            is suggested. Using the <option>-k</option> option it's possible to sort for the desired
-            key, may it be the symbol name, the translation unit name or the symbol type.
-          </para>
-          <example>
-            <title>Sorting <command>missingstatic</command> output for translation unit name
-            </title>
-            <programlisting>
-              find . -name '*.o' | missingstatic -h | sort -k2
-            </programlisting>
-          </example>
-        </refsect2>
-      </refsect1>
-      <refsect1>
-        <title>Bugs and Missing Features</title>
-        <para>
-          <command>missingstatic</command> assumes that all the sources for a module and just that
-          module will be passed to it, if more or less sources will be passed to the command, the
-          results might not be the expected ones.
-        </para>
-        <xi:include href="common.xmli" xpointer="xpointer(id('filelist.bugpara')/*)" />
-      </refsect1>
-      <refsect1>
-        <title>See Also</title>
-        <para>
-          <citation xl:href="http://blog.flameeyes.eu/">Flameeyes's Weblog</citation>
-          http://blog.flameeyes.eu/
-        </para>
-        <para>
-          Related tools:
-          <citerefentry>
-            <refentrytitle>nm</refentrytitle>
-            <manvolnum>1</manvolnum>
-          </citerefentry>,
-          <citerefentry>
-            <refentrytitle>exuberant-ctags</refentrytitle>
-            <manvolnum>1</manvolnum>
-          </citerefentry>.
-        </para>
-      </refsect1>
-    </refentry>
-  </section>
-</article>
-<!--
-    Local Variables:
-    mode: nxml
-    mode: auto-fill
-    mode: flyspell
-    ispell-local-dictionary: "english"
-    fill-column: 100
-    indent-tabs-mode: nil
-    End:
--->

data/manpages/rbelf-nm.1.xml DELETED

@@ -1,339 +0,0 @@
-<?xml version='1.0'?>
-<!--
-Copyright © 2011, Diego Elio Pettenò <flameeyes@flameeyes.eu>
-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.
-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.
-You should have received a copy of the GNU General Public License
-along with this generator; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
--->
-<article xmlns="http://docbook.org/ns/docbook"
-         xmlns:xl="http://www.w3.org/1999/xlink"
-         xmlns:xi="http://www.w3.org/2001/XInclude"
-         version="5.0" xml:lang="en">
-  <info>
-    <title>rbelf-nm</title>
-    <xi:include parse="xml" href="author.xmli" />
-  </info>
-  <section>
-    <title>Reference</title>
-    <refentry>
-      <info>
-        <date>August 2011</date>
-        <productname>ruby-elf</productname>
-      </info>
-      <refmeta>
-        <refentrytitle>rbelf-size</refentrytitle>
-        <manvolnum>1</manvolnum>
-      </refmeta>
-      <refnamediv>
-        <refname>rbelf-nm</refname>
-        <refpurpose>List symbols from ELF files</refpurpose>
-      </refnamediv>
-      <refsynopsisdiv>
-        <cmdsynopsis>
-          <command>rbelf-nm</command>
-          <arg choice="opt">
-            <option>--dynamic</option>
-          </arg>
-          <arg choice="opt">
-            <option>--demangle</option>
-          </arg>
-          <arg choice="opt">
-            <option>--sort-by</option>
-            <group rep="norepeat" choice="req">
-              <arg choice="plain">name</arg>
-              <arg choice="plain">option</arg>
-              <arg choice="plain">none</arg>
-            </group>
-          </arg>
-          <xi:include href="common.xmli"  xpointer="xpointer(id('filelist.synopsis')/*)" />
-        </cmdsynopsis>
-      </refsynopsisdiv>
-      <refsect1>
-        <title>Description</title>
-        <para>
-          <command>rbelf-nm</command> is a replacement for the standard
-          <citerefentry><refentrytitle>nm</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-          utility, as provided by GNU binutils and similar suites.
-        </para>
-      </refsect1>
-      <refsect1>
-        <title>Options</title>
-        <variablelist>
-          <varlistentry>
-            <term><option>-D</option></term>
-            <term><option>--dynamic</option></term>
-            <listitem>
-              <para>
-                Display symbols in the dynamic symbol table, not the normal symbol table. This is
-                useful to identify the symbols exported by a shared object.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><option>-C</option></term>
-            <term><option>--demangle</option></term>
-            <listitem>
-              <para>
-                Demangle encoded symbol names. Certain languages (C++) and interfaces (Java's JNI)
-                transform their native symbol names into Unix-compatible names to store in the
-                symbol tables, this option applies the opposite transformation to identify the
-                original symbols.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><option>-S</option> { <option>name</option> | <option>address</option> |
-            <option>none</option> }</term>
-            <term><option>--sort-by</option> { <option>name</option> | <option>address</option> |
-            <option>none</option> }</term>
-            <listitem>
-              <para>
-                Choose how to sort the output: by symbol name (the default), by symbol address, or
-                in the order of appearance in the symbol tables (which involves no sorting, and is
-                faster).
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><option>-V</option></term>
-            <term><option>--show-version</option></term>
-            <listitem>
-              <para>
-                Show the symbol version information in output. Version information for symbols is an
-                extension, and is implemented with different interfaces by Sun and GNU (for Linux).
-              </para>
-              <para>
-                Symbols exported with default version (the one selected for linking) are marked with
-                a <literal>@@</literal> separator, the rest are marked with a simple
-                <literal>@</literal>, while symbols without version information have no mark at all.
-              </para>
-            </listitem>
-          </varlistentry>
-          <xi:include href="common.xmli" xpointer="xpointer(id('filelist.option')/*)" />
-        </variablelist>
-      </refsect1>
-      <refsect1>
-        <title>Output</title>
-        <para>
-          Currently, the only output style implemented is BSD, which is the default of GNU
-          <command>nm</command>. In this style, the one-character symbol type code is not
-          standardised, and is thus not identical to the one provided by either the GNU
-          implementation or Ulrich Drepper's <command>eu-nm</command>.
-        </para>
-        <variablelist>
-          <varlistentry>
-            <term><literal>U</literal></term>
-            <listitem>
-              <para>
-                The symbol is undefined.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>V</literal>, <literal>v</literal></term>
-            <listitem>
-              <para>
-                The symbol is a weak reference to a data object. When uppercase, a default value is
-                provided, otherwise it is zero.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>W</literal>, <literal>w</literal></term>
-            <listitem>
-              <para>
-                The symbol is a weak reference to a function. When uppercase, a default value is
-                provided, otherwise it is zero.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>A</literal></term>
-            <listitem>
-              <para>
-                The symbol is an absolute address.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>C</literal></term>
-            <listitem>
-              <para>
-                The symbol is common.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>D</literal>, <literal>d</literal></term>
-            <listitem>
-              <para>
-                The symbol is a writable data object.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>R</literal>, <literal>r</literal></term>
-            <listitem>
-              <para>
-                The symbol is a read-only data object. Note that relocated constants are still
-                considered writable data objects as their value is set after execution.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>B</literal>, <literal>b</literal></term>
-            <listitem>
-              <para>
-                The symbol is an uninitialised data object.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>N</literal></term>
-            <listitem>
-              <para>
-                The symbol type is unspecified. This is usually used to refer to debug objects and
-                notes, but the semantics of this code differ between GNU <command>nm</command> and
-                <command>eu-nm</command>; we follow the latter.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>T</literal>, <literal>t</literal></term>
-            <listitem>
-              <para>
-                The symbol is a function (text).
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>S</literal></term>
-            <listitem>
-              <para>
-                The symbol is a section reference. The semantics of this code differ between GNU
-                <command>nm</command> and <command>eu-nm</command>; we follow the latter.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>F</literal></term>
-            <listitem>
-              <para>
-                The symbol is a file reference.
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>i</literal></term>
-            <listitem>
-              <para>
-                The symbol is an indirect function (only valid as a GNU extension).
-              </para>
-            </listitem>
-          </varlistentry>
-          <varlistentry>
-            <term><literal>i</literal></term>
-            <listitem>
-              <para>
-                The symbol is an unique global symbol (only valid as a GNU extension).
-              </para>
-            </listitem>
-          </varlistentry>
-        </variablelist>
-      </refsect1>
-      <refsect1>
-        <title>Bugs and Missing Features</title>
-        <para>
-          Contrarily to the standard <command>nm</command> implementations,
-          <command>rbelf-nm</command> does not search for <filename>a.out</filename> when no
-          parameter is provided. Instead, it waits for parameters on the standard input like the
-          other Ruby-Elf utilities.
-        </para>
-        <para>
-          Neither the full option set of GNU <command>nm</command> nor that of
-          <command>eu-nm</command> are currently implemented and require more work. No output style
-          beside BSD is currently implemented.
-        </para>
-        <para>
-          Some of the codes from GNU <command>nm</command> are not implemented.
-        </para>
-        <xi:include href="common.xmli" xpointer="xpointer(id('filelist.bugpara')/*)" />
-      </refsect1>
-      <refsect1>
-        <title>See Also</title>
-        <para>
-          <citation xl:href="http://blog.flameeyes.eu/">Flameeyes's Weblog</citation>
-          http://blog.flameeyes.eu/
-        </para>
-        <para>
-          Related tools:
-          <citerefentry>
-            <refentrytitle>nm</refentrytitle>
-            <manvolnum>1</manvolnum>
-          </citerefentry>
-        </para>
-      </refsect1>
-    </refentry>
-  </section>
-</article>
-<!--
-    Local Variables:
-    mode: nxml
-    mode: auto-fill
-    mode: flyspell
-    ispell-local-dictionary: "english"
-    fill-column: 100
-    indent-tabs-mode: nil
-    End:
--->