COMPILING

   1 To compile libabigail, you first need to install its dependencies.  At
   2 the moment the dependencies are the following Free Software packages:
   3
   4     elfutils
   5     libtool
   6     libxml2
   7
   8 If you are building from the Git repository, then you'd also need the
   9 following packages:
  10
  11     autoconf
  12     automake
  13     pkg-config
  14
  15 If you want to build the documentation of libabigail, then you also
  16 need these packages (and its dependencies):
  17
  18      doxygen
  19      python-sphinx
  20
  21 Note that if you are installing these packages in a binary form
  22 provided by your distribution, then you probably need to install the
  23 development variant of those that have one.
  24
  25 Once you have installed the development packages of the dependencies,
  26 there are two options for compiling libabigail, depending on the two
  27 kinds of source code package you have: either you've got the source
  28 code from our Git source control management system, or you've got a
  29 released tarball.
  30
  31 * Getting and compiling libabigail from Git
  32 ===========================================
  33
  34 To get the source code from git, you have to type:
  35
  36     git clone git://sourceware.org/git/libabigail.git
  37
  38 Please note that to compile libabigail from its sources in this case,
  39 you need to have the 'autoconf' page installed on your machine.
  40
  41 Then go to your local libabigail.git directory where the source code
  42 you've checked out lies and create a 'build' directory that will
  43 receive the binaries resulting from the compilation:
  44
  45     cd libabigail.git
  46     mkdir build
  47
  48 Generate the relevant build-system-related information needed to
  49 configure the package for compilation, by typing:
  50
  51     autoreconf -i
  52
  53 Then configure the package:
  54
  55     cd build
  56     ../configure --prefix=<absolute-path-of-where-you-want-the-binaries-to-be-installed>
  57
  58 Then build the package
  59
  60     make
  61
  62 And then install its resulting binaries and documentation:
  63
  64     make install
  65
  66 * Getting and compiling libabigail from released tarballs
  67 =========================================================
  68
  69 First, get a tarball from ftp://sourceware.org/pub/libabigail.
  70
  71 Then untar it and go to the resulting source directory.
  72
  73 Then create a build directory that is to receive the result of the
  74 compilation and cd into it:
  75
  76     mkdir build
  77     cd build
  78
  79 Then configure the package:
  80
  81     ../configure --prefix=<absolute-path-of-where-you-want-the-binaries-to-be-installed>
  82
  83 Then compile it:
  84
  85     make
  86
  87 Then install the resulting binaries
  88
  89     make install
  90
  91 * Building the documentation of libabigail
  92 ==========================================
  93
  94 To build the documentation of libabigail, you need to install the
  95 python-sphinx package prior to running configure.
  96
  97 Once you've done that, type:
  98
  99      make doc
 100
 101 This will generate the documentation in html, info and man format, in
 102 under the doc/ subdirectory of your build directory.
 103
 104 If you only want the html documentation (mainly the web site, apidoc and manuals) then just type:
 105
 106    make html-doc
 107
 108 If you only want to generate the man documentation, just type:
 109
 110    make man
 111
 112 If you only want to generate the info documentation, just type:
 113
 114    make info