summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <hun@n-dimensional.de>2007-11-06 20:20:00 +0100
committerHans Ulrich Niedermann <hun@n-dimensional.de>2007-11-06 20:20:00 +0100
commit5455edb9a7143edbf17d48910e97804cf00f59a4 (patch)
treed59de70c78a63788e96292b7e119060fe0a09202
parentd208fff7e61023c742e02cb3f1ab3ccdbb81a293 (diff)
downloadndim-git-utils-5455edb9a7143edbf17d48910e97804cf00f59a4.tar.gz
ndim-git-utils-5455edb9a7143edbf17d48910e97804cf00f59a4.tar.xz
ndim-git-utils-5455edb9a7143edbf17d48910e97804cf00f59a4.zip
Improve man page
-rw-r--r--git-amb/git-amb.man.in14
1 files changed, 14 insertions, 0 deletions
diff --git a/git-amb/git-amb.man.in b/git-amb/git-amb.man.in
index a92a7e6..de06d0e 100644
--- a/git-amb/git-amb.man.in
+++ b/git-amb/git-amb.man.in
@@ -82,19 +82,33 @@ The branch name will be appended to it.
Location of installation, relative to top checkout (source) dir, or absolute.
The branch name will be appended to it.
.SH EXAMPLES
+Define local build dirs, relative to top source tree dir.
.nf
$ git config amb.builddir _builds
$ git config amb.installdir _installs
.fi
.PP
+In the following example, we build two branches and compare their
+resulting installation trees. Please note that
+.I "git\-amb make"
+automatically runs the necessary precursor steps.
.nf
$ git checkout master
$ git\-amb make install
$ git checkout foo/bar
$ git\-amb make dist install
$ diff \-ru $(git\-amb installdir) $(git\-amb installdir master)
+.fi
+.PP
+The following example builds a dist tarball with all the checks and we
+then examine the files in the dist tarball.
+.nf
+ $ git\-amb make distcheck
$ git\-amb sh
<\-\-\-\-> [...] $ ls *.tar.gz
+ <\-\-\-\-> [...] $ tar tvfz moo-1.2.3.tar.gz
+ <\-\-\-\-> [...] $ exit
+ $
.fi
.SH "BUGS"
.TP