libabigail/doc/manuals/libabigail-tools.rst

#####
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.  All tools come with a bash-completion script.

Tools manuals
=============

.. toctree::
   :maxdepth: 2

   abidiff
   abipkgdiff
   abicompat
   abidw
   abilint
Initial documentation for libabigail * 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> 2014-09-26 15:02:46 +00:00			`#####`
			`Tools`
			`#####`

			`Overview`
			`========`

			`The upstream code repository of Libabigail contains several tools`
			`written using the library. They are maintained and released as part`
Add bash-completion scripts for the libabigail tools * Makefile.am: include bash-completion/Makefile.am * bash-completion/Makefile.am: New makefile for the bash-completion directory. * bash-completion/abicompat: New completion script. * bash-completion/abidiff: Likewise. * bash-completion/abidw: Likewise. * bash-completion/abilint: Likewise. * bash-completion/abinilint: Likewise. * bash-completion/abipkgdiff: Likewise. * bash-completion/abisym: Likewise. * configure.ac: Check for the bash-completion package. Handle the new --enable-bash-completion[=WHEN] configure option. * manuals/libabigail-tools.rst: Mention the scripts. Signed-off-by: Ondrej Oprala <ooprala@redhat.com> 2015-11-14 17:32:01 +00:00			`of the project. All tools come with a bash-completion script.`
Initial documentation for libabigail * 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> 2014-09-26 15:02:46 +00:00
			`Tools manuals`
			`=============`

Generate texinfo documentation properly There was a texinfo documentation that was being generated up to now, but I haven't really looked at it. Now that I have handled man pages generation, I thought I'd give the texinfo generation a closer look and ensure it's in a correct shape. This patch cleans the generation process up, changes the documentation markup so that it looks OK in the generated texinfo file and handles the install of the generated texinfo. * doc/manuals/Makefile.am: Generate texinfo doc, install it and uninstall it. * doc/manuals/libabigail-tools.rst: Do not use the :doc: syntax to refer to documents because it doesn't seem to work with sphinx right now. Rather, use a table of content. Signed-off-by: Dodji Seketeli <dodji@redhat.com> 2015-01-13 17:10:19 +00:00			`.. toctree::`
			`:maxdepth: 2`
Initial documentation for libabigail * 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> 2014-09-26 15:02:46 +00:00
Generate texinfo documentation properly There was a texinfo documentation that was being generated up to now, but I haven't really looked at it. Now that I have handled man pages generation, I thought I'd give the texinfo generation a closer look and ensure it's in a correct shape. This patch cleans the generation process up, changes the documentation markup so that it looks OK in the generated texinfo file and handles the install of the generated texinfo. * doc/manuals/Makefile.am: Generate texinfo doc, install it and uninstall it. * doc/manuals/libabigail-tools.rst: Do not use the :doc: syntax to refer to documents because it doesn't seem to work with sphinx right now. Rather, use a table of content. Signed-off-by: Dodji Seketeli <dodji@redhat.com> 2015-01-13 17:10:19 +00:00			`abidiff`
Add a manual for abipkgidiff * doc/manuals/abipkgdiff.rst: New manual file. * doc/manuals/libabigail-tools.rst: Refer to the manual for abipkgdiff. * doc/manuals/Makefile.am: Add the new manual file to source distribution. * doc/manuals/conf.py: Add the manual for abipkgdiff to section 1. Signed-off-by: Dodji Seketeli <dodji@redhat.com> 2015-07-15 14:30:46 +00:00			`abipkgdiff`
Generate texinfo documentation properly There was a texinfo documentation that was being generated up to now, but I haven't really looked at it. Now that I have handled man pages generation, I thought I'd give the texinfo generation a closer look and ensure it's in a correct shape. This patch cleans the generation process up, changes the documentation markup so that it looks OK in the generated texinfo file and handles the install of the generated texinfo. * doc/manuals/Makefile.am: Generate texinfo doc, install it and uninstall it. * doc/manuals/libabigail-tools.rst: Do not use the :doc: syntax to refer to documents because it doesn't seem to work with sphinx right now. Rather, use a table of content. Signed-off-by: Dodji Seketeli <dodji@redhat.com> 2015-01-13 17:10:19 +00:00			`abicompat`
			`abidw`
			`abilint`