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