Tizen 2.0 Release
[apps/core/preloaded/gnome-common.git] / doc / usage.txt
1 This module contains various files needed to bootstrap Gnome 2 modules
2 built from CVS.  It contains the following components:
3  1. A common "autogen.sh" script that can be used to configure a
4     source directory checked out from CVS.
5  2. Some commonly used macros (quite a small set these days -- macros
6     should be packaged with their respective modules).
7  3. Some files used to build user documentation.
8
9 To make use of the common autogen script, create a stub autogen.sh
10 script in your module that looks something like this:
11
12 ---- Cut Here ----
13 #!/bin/sh
14 srcdir=`basename $0`
15 [ -z "$srcdir" ] && srcdir=.
16
17 PKG_NAME=mypackage
18 REQUIRED_AUTOMAKE_VERSION=1.7
19
20 if [ ! -f "$srcdir/somefile-that-is-only-in-mypackage" ]; then
21  echo "$srcdir doesn't look like source directory for $PKG_NAME" >&2
22  exit 1
23 fi
24
25 . gnome-autogen.sh
26 ---- Cut Here ----
27
28 Then put the following in your configure.ac or configure.in file:
29   GNOME_COMMON_INIT
30
31 This macro is equivalent to the following two lines (which you can use
32 instead if you don't want to depend on gnome-common macros):
33   AC_SUBST([ACLOCAL_AMFLAGS], ["\${ACLOCAL_FLAGS}"])
34
35 Or if you are using the AC_CONFIG_MACRO_DIR macro:
36   AC_SUBST([ACLOCAL_AMFLAGS], ["-I $ac_macro_dir \${ACLOCAL_FLAGS}"])
37
38 This will make sure that autoconf macros will be found when you
39 rebuild the package without rerunning autogen.sh.
40