summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2014-05-02 15:41:29 +0200
committerPhilip Withnall <philip.withnall@collabora.co.uk>2014-05-02 17:37:18 +0200
commit0d59b7cb3b6e842ba87f4ebc1a56f654ad52301f (patch)
tree079cdccace926c4e641a14159484845284dcaa98
parentf5bd3785edfbebef04089fc52f804249d88b89de (diff)
downloadgnome-common-0d59b7cb3b6e842ba87f4ebc1a56f654ad52301f.tar.gz
doc: Move doc/usage.txt to README and update
We don’t like references to CVS any more. Update the guidelines to no longer reference GNOME_COMMON_INIT. https://bugzilla.gnome.org/show_bug.cgi?id=729410
-rw-r--r--README (renamed from doc/usage.txt)24
1 files changed, 11 insertions, 13 deletions
diff --git a/doc/usage.txt b/README
index d2294e5..cf0fd40 100644
--- a/doc/usage.txt
+++ b/README
@@ -1,10 +1,9 @@
-This module contains various files needed to bootstrap Gnome 2 modules
-built from CVS. It contains the following components:
+This module contains various files needed to bootstrap GNOME 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 CVS.
+ 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:
@@ -17,22 +16,21 @@ srcdir=`dirname $0`
PKG_NAME=mypackage
REQUIRED_AUTOMAKE_VERSION=1.7
-if [ ! -f "$srcdir/somefile-that-is-only-in-mypackage" ]; then
+if [ ! -f "$srcdir/configure.ac" ]; then
echo "$srcdir doesn't look like source directory for $PKG_NAME" >&2
exit 1
fi
-. gnome-autogen.sh
+which gnome-autogen.sh || {
+ echo "You need to install gnome-common from GNOME Git"
+ exit 1
+}
+
+. gnome-autogen.sh "$@"
---- Cut Here ----
Then put the following in your configure.ac or configure.in file:
- GNOME_COMMON_INIT
-
-This macro is equivalent to the following two lines (which you can use
-instead if you don't want to depend on gnome-common macros):
- AC_SUBST([ACLOCAL_AMFLAGS], ["\${ACLOCAL_FLAGS}"])
-
-Or if you are using the AC_CONFIG_MACRO_DIR macro:
+ AC_CONFIG_MACRO_DIR([m4])
AC_SUBST([ACLOCAL_AMFLAGS], ["-I $ac_macro_dir \${ACLOCAL_FLAGS}"])
This will make sure that autoconf macros will be found when you