summaryrefslogtreecommitdiff
path: root/doc/usage.txt
diff options
context:
space:
mode:
authormonsta <[email protected]>2015-10-20 11:27:46 +0300
committermonsta <[email protected]>2015-10-20 11:31:24 +0300
commit5aac4bf9650cca208f7da857e022e7492e2f8d25 (patch)
treecd5e078e1c00b5f7c06b50d5ee00ec4ff166619f /doc/usage.txt
parentc6cb673fc7001d13c3c821a3fbd542a3388cfaac (diff)
downloadmate-common-5aac4bf9650cca208f7da857e022e7492e2f8d25.tar.bz2
mate-common-5aac4bf9650cca208f7da857e022e7492e2f8d25.tar.xz
update example script from upstream and just mention it in usage.txt
(instead of listing the whole script in it)
Diffstat (limited to 'doc/usage.txt')
-rw-r--r--doc/usage.txt23
1 files changed, 4 insertions, 19 deletions
diff --git a/doc/usage.txt b/doc/usage.txt
index f591662..cdadc19 100644
--- a/doc/usage.txt
+++ b/doc/usage.txt
@@ -1,29 +1,14 @@
This module contains various files needed to bootstrap MATE modules
-built from GIT. It contains the following components:
+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.
+ 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 ----
+script in your module. See the example script in autogen.sh.example
+file in mate-common documentation folder.
Then put the following in your configure.ac or configure.in file:
MATE_COMMON_INIT