RepoMirrors/libabigail
1
0
Fork 0
mirror of git://sourceware.org/git/libabigail.git synced 2025-01-29 12:42:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial documentation for libabigail

Browse Source 
* doc/manuals/Makefile: New file, generated by sphinx-quickstart.
	* doc/manuals/abidiff.rst: New manual for abidiff.
	* doc/manuals/abidw.rst: New manual for abidw.
	* doc/manuals/abilint.rst: New manual for abilint.
	* doc/manuals/conf.py: New configuration file generated by sphinx-quickstart.
	* doc/manuals/index.rst: The root of the this documentation.
	* doc/manuals/libabigail-overview.rst: The overview of libabigail.
	* doc/manuals/tools.rst: The root of the tools manuals.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
This commit is contained in:
Dodji Seketeli 2014-09-26 17:02:46 +02:00
parent e807eb86e6
commit 2f296a7846
8 changed files with 868 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

153
doc/manuals/Makefile Normal file
View File

@ -0,0 +1,153 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Libabigailmanuals.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Libabigailmanuals.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Libabigailmanuals"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Libabigailmanuals"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

205
doc/manuals/abidiff.rst Normal file
View File

@ -0,0 +1,205 @@
=======
abidiff
=======
abidiff compares the Application Binary Interfaces (ABI) of two shared
libraries in `ELF`_ format. It emits a meaningful report describing the
differences between the two ABIs.
The two input shared libraries must be accompanied with their debug
information in `DWARF`_ format.
Invocation
==========
::
abidiff [options] <first-shared-library> <second-shared-library>
Options
=======
* --help
Displays a short help about the command and exit.
* --debug-info-dir1 <*di-path1*>
For cases where the debug information for *first-shared-library*
is split out into a separate file, tells ``abidiff`` where to find
that separate debug information file.
Note that *di-path* must point to the root directory under which
the debug information is arranged in a tree-like manner. Under
Red Hat based systems, that directory is usually
``<root>/usr/lib/debug``.
Note also that this option is not mandatory for split debug
information installed by your system's package manager because
then ``abidiff`` knows where to find it.
* --debug-info-dir2 <*di-path2*>
Like ``--debug-info-dir1``, this options tells ``abidiff`` where
to find the split debug information for the
*second-shared-library* file.
* --stat
Rather than displaying the detailed ABI differences between
*first-shared-library* and *second-shared-library*, just display
some summary statistics about these differences.
* --symtabs
Only display the symbol tables of the *first-shared-library* and
*second-shared-library*.
* --deleted-fns
In the resulting report about the differences between
*first-shared-library* and *second-shared-library*, only display
the globally defined functions that got deleted from
*first-shared-library*.
* --changed-fns
In the resulting report about the differences between
*first-shared-library* and *second-shared-library*, only display
the changes in sub-types of the global functions defined in
*first-shared-library*.
* --added-fns
In the resulting report about the differences between
*first-shared-library* and *second-shared-library*, only display
the globally defined functions that were added to
*second-shared-library*.
* --deleted-vars
In the resulting report about the differences between
*first-shared-library* and *second-shared-library*, only display
the globally defined variables that were deleted from
*first-shared-library*.
* --changed-vars
In the resulting report about the differences between
*first-shared-library* and *second-shared-library*, only display
the changes in the sub-types of the global variables defined in
*first-shared-library*
* --added-vars
In the resulting report about the differences between
*first-shared-library* and *second-shared-library*, only display
the global variables that were added (defined) to
*second-shared-library*.
* --no-linkage-name
In the resulting report, do not display the linkage names of
the added, removed, or changed functions or variables.
* --drop <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, drop the globally defined
functions and variables which name match the regular expression
*regex*. As a result, no change involving these functions or
variables will be emitted in the diff report.
* --drop-fn <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, drop the globally defined
functions which name match the regular expression *regex*. As a
result, no change involving these functions will be emitted in the
diff report.
* --drop-fn <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, drop the globally defined
functions matching a the regular expression *regex*. As a result,
no change involving these functions will be emitted in the diff
report.
* --drop-var <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, drop the globally defined
variables matching a the regular expression *regex*.
* --keep <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, keep the globally defined
functions and variables which names match the regular expression
*regex*. All other functions and variables are dropped on the
floor and will thus not appear in the resulting diff report.
* --keep-fn <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, keep the globally defined
functions which name match the regular expression *regex*. All
other functions are dropped on the floor and will thus not appear
in the resulting diff report.
* --keep-var <*regex*>
When reading the *first-shared-library* and
*second-shared-library* ELF input files, keep the globally defined
which names match the regular expression *regex*. All other
variables are dropped on the floor and will thus not appear in the
resulting diff report.
* --harmless
In the diff report, display only the :ref:`harmless <harmlesslabel>`
changes. By default, the harmless changes are filtered out of the
diff report keep the clutter to a minimum and have a greater
change to spot real ABI issues.
* --no-harmful
In the diff report, do not display the :ref:`harmful <harmfullabel>`
changes. By default, only the harmful changes are displayed in
diff report.
* --redundant
In the diff report, do not display redundant changes. A redundant
change is a change that has been displayed elsewhere in the report.
Notes
=====
.. _harmlesslabel:
Harmless changes
----------------
A change in the diff report is considered harmless if it will not
cause any ABI compatibility issue. That is, it will not prevent
an application dynamically linked against *first-shared-library*
to keep working reasonably with *second-shared-library*.
By default, ``abidiff`` filters harmless changes from the diff report.
.. _harmfullabel:
Harmful changes
--------------
A change in the diff report is considered harmful if it might cause
ABI compatibility issues. That is, it might prevent an application
dynamically linked against *first-shared-library* to keep working
reasonably with *second-shared-library*.
.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
.. _DWARF: http://www.dwarfstd.org

83
doc/manuals/abidw.rst Normal file
View File

@ -0,0 +1,83 @@
======
abidw
======
abidw reads a shared library in `ELF`_ format and emits an XML
representation of its ABI to standard output. The emitted
representation includes all the globally defined functions and
variables, along with a complete representation of their types. It
also includes a representation of the globally defined ELF symbols of
the file. The input shared library must contain associated debug
information in `DWARF`_ format.
Invocation
==========
::
abidw [options] [<path-to-elf-file>]
Options
=======
* --help
Display a short help about the command and exit.
* --debug-info-dir <*dir-path*>
In cases where the debug info for *path-to-elf-file* is in a
separate file that is located in a non-standard place, this tells
``abidw`` where to look for that debug info file.
Note that *dir-path* must point to the root directory under which
the debug information is arranged in a tree-like manner. Under
Red Hat based systems, that directory is usually
``<root>/usr/lib/debug``.
Note that this option is not mandatory for split debug information
installed by your system's package manager because then
``abidw`` knows where to find it.
* --out-file <*file-path*>
This option instructs ``abidw`` to emit the XML representation of
*path-to-elf-file* into the file *file-path*, rather than emitting
it to its standard output.
* --check-alternate-debug-info <*elf-path*>
If the debug info for the file *elf-path* contains a reference to
an `alternate debug info <alt-di-label>`_ file, ``abidw`` checks
that it can find that alternate debug info file. In that case, it
emits a meaningful success message mentioning the full path to the
alternate debug info file found. Otherwise, it emits an error
code.
* --check-alternate-debug-info-base-name <*elf-path*>
Like ``--check-alternate-debug-info``, but in the success message,
only mention the base name of the debug info file; not its full path.
Notes
=====
.. _alt-di-label:
Alternate debug info files
--------------------------
As of the version 4 of the DWARF specification, `Alternate debug
information <http://www.dwarfstd.org/ShowIssue.php?issue=120604.1>`_
is a `GNU`_ extension to the DWARF specification. It has however been
proposed for inclusion into the upcoming version 5 of the DWARF
standard. You can read more about the GNU extensions to the DWARF
standard `here
<https://fedorahosted.org/elfutils/wiki/DwarfExtensions>`_.
.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
.. _DWARF: http://www.dwarfstd.org
.. _GNU: http://www.gnu.org

68
doc/manuals/abilint.rst Normal file
View File

@ -0,0 +1,68 @@
=======
abilint
=======
abilint parses the native XML representation of an ABI as emitted by
:doc:`abidw`. Once it has parsed the XML representation of the ABI,
``abilint`` builds and in-memory model from it. It then tries to save
it back to an XML form, to standard output. If that read-write
operation succeeds chances are the input XML ABI representation is
meaningful.
Note that the main intent of this tool to help debugging issues in the
underlying Libabigail library.
Note also that ``abilint`` can also read an `ELF`_ input file, build the
in-memory model for its ABI, and serialize that model back into XML to
standard output. In that case, the `ELF`_ input file must be
accompanied with its debug information in the `DWARF`_ format.
Invocation
==========
::
abilint [options] [<abi-file1>]
Options
=======
* --help
Display a short help message and exits.
* --debug-info-dir <*path*>
When reading an `ELF`_ input file which debug information is split
out into a separate file, this options tells ``abilint`` where to
find that separate debug information file.
Note that *path* must point to the root directory under which the
debug information is arranged in a tree-like manner. Under Red
Hat based systems, that directory is usually
``<root>/usr/lib/debug``.
Note also that this option is not mandatory for split debug
information installed by your system's package manager because
then ``abidiff`` knows where to find it.
* --diff
For XML inputs, perform a text diff between the input and the
memory model saved back to disk. This can help to spot issues in
the handling of the XML format by the underlying Libabigail library.
* --noout
Do not display anything on standard output. The return code of
the command is the only way to know if the command succeeded.
* --stdin|--
Read the input content from standard input.
* --tu
Expect the input XML to represent a single translation unit.
.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
.. _DWARF: http://www.dwarfstd.org

285
doc/manuals/conf.py Normal file
View File

@ -0,0 +1,285 @@
# -*- coding: utf-8 -*-
#
# Libabigail manuals documentation build configuration file, created by
# sphinx-quickstart on Fri Sep 26 09:50:31 2014.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Libabigail'
copyright = u'2014, Dodji Seketeli'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Libabigailmanualsdoc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Libabigailmanuals.tex', u'Libabigail manuals Documentation',
u'Dodji Seketeli', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'libabigailmanuals', u'Libabigail manuals Documentation',
[u'Dodji Seketeli'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Libabigailmanuals', u'Libabigail manuals Documentation',
u'Dodji Seketeli', 'Libabigailmanuals', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# -- Options for Epub output ---------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'Libabigail manuals'
epub_author = u'Dodji Seketeli'
epub_publisher = u'Dodji Seketeli'
epub_copyright = u'2014, Dodji Seketeli'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
#epub_exclude_files = []
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True

13
doc/manuals/index.rst Normal file
View File

@ -0,0 +1,13 @@
.. Libabigail manuals documentation master file, created by
sphinx-quickstart on Fri Sep 26 09:50:31 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Libabigail manual
=================
.. toctree::
:maxdepth: 3
libabigail-overview
tools

43
doc/manuals/libabigail-overview.rst Normal file
View File

@ -0,0 +1,43 @@
#######################
Overview of Libabigail
#######################
Libabigail stands for the Application Binary Interface Generic
Analysis and Instrumentation Library.
It aims at helping developers and software distributors to spot some
ABI-related issues like interface incompatibility in `ELF`_ shared
libraries.
The type of interface incompatibilities that ``libabigail`` focuses on
is related to changes on the exported ELF functions and variables
symbols, as well as layout and size changes of data types of the
functions and variables exported by shared libraries.
In other words, if the return type of a function exported by a shared
library changes in an incompatible way from one version of a given
shared library to another, we want ``libabigail`` to help people catch
that.
In more concrete terms, ``libabigail`` can parse a shared library in
`ELF`_ format, accompanied with its associated debug information in
`DWARF`_ format, build an internal representation of all the functions
and variables it exports, along with their types. It also builds an
internal representation of the `ELF_ symbols`_ of these functions and
variables. That information about these exported functions and
variables is roughly what we consider as being the ABI of the shared
library, at least, in the scope of Libabigail.
Aside of this internal representation, ``libabigail`` provides
facilities to perform deep comparisons of two ABIs. That is, it can
compare the types of two sets of functions or variables and represents
the result in a way that allows it to emit textual reports about the
differences.
This allows us to write tools like :doc:`abidiff` that can compare the
ABI of two shared libraries and represent the result in a meaningful
enough way to help us spot ABI incompatibilities.
.. _ELF: http://en.wikipedia.org/wiki/Executable_and_Linkable_Format
.. _DWARF: http://www.dwarfstd.org
.. _Elf symbols: https://blogs.oracle.com/ali/entry/inside_elf_symbol_tables

18
doc/manuals/tools.rst Normal file
View File

@ -0,0 +1,18 @@
#####
Tools
#####
Overview
========
The upstream code repository of Libabigail contains several tools
written using the library. They are maintained and released as part
of the project.
Tools manuals
=============
* :doc:`abidiff`
* :doc:`abidw`
* :doc:`abilint`