summaryrefslogtreecommitdiff
path: root/doc/usage.txt
blob: f5916624a8fd02d8e2e7e082ae138182e6bcfffa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
This module contains various files needed to bootstrap MATE modules
built from GIT.  It contains the following components:
 1. A common "autogen.sh" script that can be used to configure a
    source directory checked out from GIT.
 2. Some commonly used macros (quite a small set these days -- macros
    should be packaged with their respective modules).
 3. Some files used to build user documentation.

To make use of the common autogen script, create a stub autogen.sh
script in your module that looks something like this:

---- Cut Here ----
#!/bin/sh
srcdir=`basename $0`
[ -z "$srcdir" ] && srcdir=.

PKG_NAME=mypackage
REQUIRED_AUTOMAKE_VERSION=1.7

if [ ! -f "$srcdir/somefile-that-is-only-in-mypackage" ]; then
 echo "$srcdir doesn't look like source directory for $PKG_NAME" >&2
 exit 1
fi

. mate-autogen
---- Cut Here ----

Then put the following in your configure.ac or configure.in file:
  MATE_COMMON_INIT

This macro is equivalent to the following two lines (which you can use
instead if you don't want to depend on mate-common macros):
  AC_SUBST([ACLOCAL_AMFLAGS], ["\${ACLOCAL_FLAGS}"])

Or if you are using the AC_CONFIG_MACRO_DIR macro:
  AC_SUBST([ACLOCAL_AMFLAGS], ["-I $ac_macro_dir \${ACLOCAL_FLAGS}"])

This will make sure that autoconf macros will be found when you
rebuild the package without rerunning autogen.sh.