diff options
| author | Hans Ulrich Niedermann <hun@n-dimensional.de> | 2007-11-02 19:33:58 +0100 |
|---|---|---|
| committer | Hans Ulrich Niedermann <hun@n-dimensional.de> | 2007-11-02 19:33:58 +0100 |
| commit | 5e819501395be3428f072e7ce295bfbb23d3e82b (patch) | |
| tree | b2a1d7bfe01617af745e305f22d0455a4b2d8f33 | |
| parent | fbf110cec511ed304a160932bf89c00c0b49b912 (diff) | |
| download | ndim-git-utils-5e819501395be3428f072e7ce295bfbb23d3e82b.tar.gz ndim-git-utils-5e819501395be3428f072e7ce295bfbb23d3e82b.tar.xz ndim-git-utils-5e819501395be3428f072e7ce295bfbb23d3e82b.zip | |
Improve man page, Release 1.3v1.3
| -rw-r--r-- | configure.ac | 2 | ||||
| -rw-r--r-- | src/git-amb.1.in | 42 |
2 files changed, 32 insertions, 12 deletions
diff --git a/configure.ac b/configure.ac index 77243b4..f729f17 100644 --- a/configure.ac +++ b/configure.ac @@ -1,6 +1,6 @@ AC_PREREQ(2.61) AC_INIT([ndims git utilities], - [1.2.1], + [1.3], [hun@n-dimensional.de], [ndim-git-utils]) AC_CONFIG_SRCDIR([src/git-amb.1.in]) diff --git a/src/git-amb.1.in b/src/git-amb.1.in index 81065b5..1428c19 100644 --- a/src/git-amb.1.in +++ b/src/git-amb.1.in @@ -50,10 +50,18 @@ The optional branch is the branch to print the builddir for. Print ${installdir}. The optional branch is the branch to print the installdir for. .SH CONFIGURATION -Get the value with -.B git config amb.foo -or set it with -.B git config amb.foo value +Use +.B git\-config +to get and set the config values. +If a config value is not set, +.B git\-amb +uses a built\-in default, which is not documented. Always run the +.B git\-amb +commands +.I builddir +and +.I installdir +to determine the respective directory. .SS amb.builddir Location of build tree, relative to top checkout (source) dir, or absolute. The branch name will be appended to it. @@ -68,14 +76,14 @@ The branch name will be appended to it. .PP .nf $ git checkout master - $ git-amb make install + $ git\-amb make install $ git checkout foo/bar - $ git-amb make dist install - $ diff -ru $(git-amb installdir) $(git-amb installdir master) - $ git-amb sh - <----> [...] $ ls *.tar.gz + $ git\-amb make dist install + $ diff \-ru $(git\-amb installdir) $(git\-amb installdir master) + $ git\-amb sh + <\-\-\-\-> [...] $ ls *.tar.gz .fi -.SH "TODO" +.SH "BUGS" .TP .B "Access to build results" Could be better. @@ -89,8 +97,20 @@ Exhibits problems, e.g. starting and then running .B "git checkout other\-branch" from another terminal. +.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 duplicate the functionality of autoreconf(1), they make two +independent steps into one (running both automake & +Co. and ./configure), they do not allow srcdir != builddir builds. .SH AUTHORS .B "git\-amb" was written by Hans Ulrich Niedermann. .SH "SEE ALSO" -git-branch(1), git-checkout(1), git-config(1). +autoreconf(1), git\-branch(1), git\-checkout(1), git\-config(1). |