Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Document the basics of building from git

  • Loading branch information...
commit 6170b048753a0d3801ccd7a6fdf32d06bf3d3111 1 parent 03c54cb
@lutter authored
Showing with 43 additions and 2 deletions.
  1. +37 −0 HACKING
  2. +1 −1  Makefile.am
  3. +5 −1 README
View
37 HACKING
@@ -0,0 +1,37 @@
+This file explains some details about developing the Augeas C library.
+
+Check out the sources
+---------------------
+
+The sources are in a git repo (which you presumably found already)
+
+ git clone git://git.fedorahosted.org/git/augeas.git
+
+Building from git
+-----------------
+
+ Besides the usual build tools (gcc, autoconf, automake etc.) you need the
+ following tools and libraries to build Augeas:
+
+ * Bison
+ * Flex
+ * readline-devel
+ * libselinux-devel (optional)
+
+ Augeas uses gnulib, and you need a checkout of gnulib. The build scripts
+ can create a checkout for you behind the scenes - though if you already
+ have a gnulib checkout, you can pass its location to autogen.sh with the
+ --gnulib-srcdir option.
+
+ At its simplest, you build Augeas from git by running the following
+ commands in the toplevel directory of your Augeas checkout:
+
+ ./autogen.sh [--gnulib-srcdir=$GNULIB_CHECKOUT]
+ make && make install
+
+ It is recommended though to turn on a few development features when
+ building; in particular, stricter compiler warnings and some debug
+ logging. You can pass these options either to autogen.sh or to
+ configure. You'd then run autogen like this:
+
+ ./autogen.sh --enable-compile-warnings=error --enable-debug=yes
View
2  Makefile.am
@@ -8,7 +8,7 @@ lenstestdir=$(datadir)/augeas/lenses/dist/tests
dist_lens_DATA=$(wildcard lenses/*.aug)
dist_lenstest_DATA=$(wildcard lenses/tests/*.aug)
-EXTRA_DIST=augeas.spec build/aux/move-if-change Makefile.am
+EXTRA_DIST=augeas.spec build/aux/move-if-change Makefile.am HACKING
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = augeas.pc
View
6 README
@@ -59,12 +59,16 @@ Non-goals
Building
--------
+ These instructions apply to building a released tarball. If you want to
+ build from a git checkout, see the file HACKING.
+
See the generic instructions in INSTALL. Generally,
./configure
make && make install
should be all that is needed.
- You need to have readline-devel installed
+ You need to have readline-devel installed. On systems that support
+ SELinux, you should also install libselinux-devel.
Documentation
-------------
Please sign in to comment.
Something went wrong with that request. Please try again.