summaryrefslogtreecommitdiffstats
path: root/git-amb
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <hun@n-dimensional.de>2007-11-06 20:13:42 +0100
committerHans Ulrich Niedermann <hun@n-dimensional.de>2007-11-06 20:13:42 +0100
commitd208fff7e61023c742e02cb3f1ab3ccdbb81a293 (patch)
treedf3c571835159d4ba6326cdb1ba51e52efe933b5 /git-amb
parent0070558150bf2d0bedd77f8f651ebb41acd6552f (diff)
downloadndim-git-utils-d208fff7e61023c742e02cb3f1ab3ccdbb81a293.tar.gz
ndim-git-utils-d208fff7e61023c742e02cb3f1ab3ccdbb81a293.tar.xz
ndim-git-utils-d208fff7e61023c742e02cb3f1ab3ccdbb81a293.zip
Improve man page.
Diffstat (limited to 'git-amb')
-rw-r--r--git-amb/git-amb.man.in42
1 files changed, 26 insertions, 16 deletions
diff --git a/git-amb/git-amb.man.in b/git-amb/git-amb.man.in
index 3707fc0..a92a7e6 100644
--- a/git-amb/git-amb.man.in
+++ b/git-amb/git-amb.man.in
@@ -8,6 +8,9 @@ git-amb \- git automake build utitilty
.SH DESCRIPTION
Build automake based git checkout in branch specific build and install trees.
That makes it easy to compare build results from different branches.
+.PP
+This requires an automake based source tree which can build in a
+separate build directory.
.SH "COMMAND OVERVIEW"
.TP
.B "git\-amb autoreconf [params...]"
@@ -15,18 +18,22 @@ Run autoreconf on ${top_srcdir}.
Optional params will be passed on to autoreconf.
.TP
.B "git\-amb configure [params...]"
-Run configure in ${top_builddir}.
+Run configure in ${top_builddir} with
+.I "\-\-enable\-maintainer\-mode"
+and
+.I "\-\-prefix"
+set appropriately.
Optional params will be passed on to configure.
-Runs
+If necessary, runs
.I "git\-amb autoreconf"
-if necessary.
+first.
.TP
.B "git\-amb make [params...]"
Run make in ${top_builddir}.
Optional params will be passed on to make.
-Runs
+If necessary, runs
.I "git\-amb configure"
-if necessary.
+first.
.TP
.B "git\-amb sh [params...]"
Start shell in ${top_builddir}.
@@ -111,19 +118,22 @@ would work equally well for many other SCMs.
.TP
.B "Why just automake?"
Any build system which works in similar stages should work:
-Create BS (autoreconf), configure BS (configure), run build (make).
+Create BS (autoreconf), configure BS (configure), execute BS (make).
+cmake(1) could be one.
.SH "NON-BUGS"
.TP
-.B "autogen.sh scripts"
-It is a feature that
-.B git\-amb
-does not support
-.I "autgen.sh"
-scripts. Custom autogen.sh script are almost always broken in
-multiple aspects: They unnecessarily duplicate the functionality of
-autoreconf(1), they join two independent steps into one (running both
-automake & Co. and ./configure), they do not allow srcdir != builddir
-builds.
+.B "No support for autogen.sh scripts"
+Not supporting
+.I "autogen.sh"
+scripts is a
+.B "git\-amb"
+feature, not a bug.
+.I "autogen.sh"
+scripts are almost always broken in at least one way: They
+unnecessarily duplicate the functionality of autoreconf(1), they join
+two independent steps into one (running both automake &
+Co. and ./configure), they do not allow srcdir != builddir builds, and
+there is no real standard about what exactly they do, and how.
.SH AUTHORS
.B "git\-amb"
was written by Hans Ulrich Niedermann.