From 5c21e10c01d49baec611694882d30b97fba8b5b1 Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Tue, 6 Nov 2007 03:13:37 +0100 Subject: Rename man page file to git-amb.man --- Makefile.am | 6 +-- configure.ac | 4 +- git-amb/Makefile-files | 4 +- git-amb/git-amb.1.in | 125 ---------------------------------------------- git-amb/git-amb.man.in | 125 ++++++++++++++++++++++++++++++++++++++++++++++ m4/ndim_detect_man2txt.m4 | 23 ++++++++- 6 files changed, 153 insertions(+), 134 deletions(-) delete mode 100644 git-amb/git-amb.1.in create mode 100644 git-amb/git-amb.man.in diff --git a/Makefile.am b/Makefile.am index e028901..84338a0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,7 +2,7 @@ CLEANFILES = BUILT_SOURCES = EXTRA_DIST = bin_SCRIPTS = -man_MANS = +man1_MANS = UPLOAD_FILES = doc_DATA = dist_doc_DATA = @@ -14,8 +14,8 @@ include doc/Makefile-files include git-amb/Makefile-files if HAVE_NDIM_MAN2TXT -.1.txt: - set -x; $(NDIM_MAN2TXT) "$<" > "$@.new" +.man.txt: + $(NDIM_MAN2TXT) "$<" > "$@.new" test -s "$@.new" mv -f "$@.new" "$@" endif diff --git a/configure.ac b/configure.ac index 83f0a9f..70ad339 100644 --- a/configure.ac +++ b/configure.ac @@ -3,7 +3,7 @@ AC_INIT([ndims git utilities], [1.6.3], [hun@n-dimensional.de], [ndim-git-utils]) -AC_CONFIG_SRCDIR([git-amb/git-amb.1.in]) +AC_CONFIG_SRCDIR([git-amb/git-amb.in]) AC_CONFIG_AUX_DIR([auto-aux]) AC_CONFIG_MACRO_DIR([m4]) AM_INIT_AUTOMAKE([-Wall foreign 1.10 dist-bzip2 readme-alpha std-options]) @@ -12,6 +12,6 @@ m4_pattern_forbid([NDIM_DETECT_MAN2TXT])dnl NDIM_DETECT_MAN2TXT()dnl AC_CONFIG_FILES([Makefile]) -AC_CONFIG_FILES([git-amb/git-amb.1]) +AC_CONFIG_FILES([git-amb/git-amb.man]) AC_CONFIG_FILES([git-amb/git-amb]) AC_OUTPUT diff --git a/git-amb/Makefile-files b/git-amb/Makefile-files index 2aa4aeb..3af3afb 100644 --- a/git-amb/Makefile-files +++ b/git-amb/Makefile-files @@ -3,8 +3,8 @@ bin_SCRIPTS += git-amb/git-amb EXTRA_DIST += git-amb/git-amb.in UPLOAD_FILES += git-amb/git-amb -man_MANS += git-amb/git-amb.1 -EXTRA_DIST += git-amb/git-amb.1.in +man1_MANS += git-amb/git-amb.man +EXTRA_DIST += git-amb/git-amb.man.in if HAVE_NDIM_MAN2TXT dist_doc_DATA += git-amb/git-amb.txt diff --git a/git-amb/git-amb.1.in b/git-amb/git-amb.1.in deleted file mode 100644 index 8a15952..0000000 --- a/git-amb/git-amb.1.in +++ /dev/null @@ -1,125 +0,0 @@ -.TH GIT-AMB 1 "@PACKAGE_TARNAME@ @PACKAGE_VERSION@" "2007\-11\-02" "@PACKAGE_NAME@ @PACKAGE_VERSION@" -.SH NAME -git-amb \- git automake build utitilty -.SH SYNOPSIS -.B "git\-amb" -.RB "command" -.RI [ params ] -.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. -.SH "COMMAND OVERVIEW" -.TP -.B "git\-amb autoreconf [params...]" -Run autoreconf on ${top_srcdir}. -Optional params will be passed on to autoreconf. -.TP -.B "git\-amb configure [params...]" -Run configure in ${top_builddir}. -Optional params will be passed on to configure. -.TP -.B "git\-amb make [params...]" -Run make in ${top_builddir}. -Optional params will be passed on to make. -.TP -.B "git\-amb sh [params...]" -Start shell in ${top_builddir}. -Optional params will be passed on to the shell. -.TP -.B "git\-amb clean [branch]" -Run 'make clean' in ${top_builddir}. -The optional branch is the branch to clean up. -.TP -.B "git\-amb distclean [branch]" -Run 'make distclean' in ${top_builddir}. -The optional branch is the branch to clean up. -.TP -.B "git\-amb purge [branch]" -Remove both build and install tree. -The optional branch is the branch to purge. -.TP -.B "git\-amb uninstall [branch]" -Remove ${installdir}. -The optional branch is the branch to uninstall. -.TP -.B "git\-amb builddir [branch]" -Print ${builddir}. -The optional branch is the branch to print the builddir for. -.TP -.B "git\-amb installdir [branch]" -Print ${installdir}. -The optional branch is the branch to print the installdir for. -.SH CONFIGURATION -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. -.SS amb.installdir -Location of installation, relative to top checkout (source) dir, or absolute. -The branch name will be appended to it. -.SH EXAMPLES -.nf - $ git config amb.builddir _builds - $ git config amb.installdir _installs -.fi -.PP -.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) - $ git\-amb sh - <\-\-\-\-> [...] $ ls *.tar.gz -.fi -.SH "BUGS" -.TP -.B "Access to build results" -Could be better. -.TP -.B "User Interface" -Should be more consistent, smaller. -.TP -.B "Concurrent Usage" -Exhibits problems, e.g. starting -.B "git\-amb sh" -and then running -.B "git checkout other\-branch" -from another terminal. -.TP -.B "Why just git?" -The idea behind -.B "git\-amb" -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). -.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" -autoreconf(1), git\-branch(1), git\-checkout(1), git\-config(1). diff --git a/git-amb/git-amb.man.in b/git-amb/git-amb.man.in new file mode 100644 index 0000000..8a15952 --- /dev/null +++ b/git-amb/git-amb.man.in @@ -0,0 +1,125 @@ +.TH GIT-AMB 1 "@PACKAGE_TARNAME@ @PACKAGE_VERSION@" "2007\-11\-02" "@PACKAGE_NAME@ @PACKAGE_VERSION@" +.SH NAME +git-amb \- git automake build utitilty +.SH SYNOPSIS +.B "git\-amb" +.RB "command" +.RI [ params ] +.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. +.SH "COMMAND OVERVIEW" +.TP +.B "git\-amb autoreconf [params...]" +Run autoreconf on ${top_srcdir}. +Optional params will be passed on to autoreconf. +.TP +.B "git\-amb configure [params...]" +Run configure in ${top_builddir}. +Optional params will be passed on to configure. +.TP +.B "git\-amb make [params...]" +Run make in ${top_builddir}. +Optional params will be passed on to make. +.TP +.B "git\-amb sh [params...]" +Start shell in ${top_builddir}. +Optional params will be passed on to the shell. +.TP +.B "git\-amb clean [branch]" +Run 'make clean' in ${top_builddir}. +The optional branch is the branch to clean up. +.TP +.B "git\-amb distclean [branch]" +Run 'make distclean' in ${top_builddir}. +The optional branch is the branch to clean up. +.TP +.B "git\-amb purge [branch]" +Remove both build and install tree. +The optional branch is the branch to purge. +.TP +.B "git\-amb uninstall [branch]" +Remove ${installdir}. +The optional branch is the branch to uninstall. +.TP +.B "git\-amb builddir [branch]" +Print ${builddir}. +The optional branch is the branch to print the builddir for. +.TP +.B "git\-amb installdir [branch]" +Print ${installdir}. +The optional branch is the branch to print the installdir for. +.SH CONFIGURATION +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. +.SS amb.installdir +Location of installation, relative to top checkout (source) dir, or absolute. +The branch name will be appended to it. +.SH EXAMPLES +.nf + $ git config amb.builddir _builds + $ git config amb.installdir _installs +.fi +.PP +.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) + $ git\-amb sh + <\-\-\-\-> [...] $ ls *.tar.gz +.fi +.SH "BUGS" +.TP +.B "Access to build results" +Could be better. +.TP +.B "User Interface" +Should be more consistent, smaller. +.TP +.B "Concurrent Usage" +Exhibits problems, e.g. starting +.B "git\-amb sh" +and then running +.B "git checkout other\-branch" +from another terminal. +.TP +.B "Why just git?" +The idea behind +.B "git\-amb" +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). +.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" +autoreconf(1), git\-branch(1), git\-checkout(1), git\-config(1). diff --git a/m4/ndim_detect_man2txt.m4 b/m4/ndim_detect_man2txt.m4 index ad08d74..96986d1 100644 --- a/m4/ndim_detect_man2txt.m4 +++ b/m4/ndim_detect_man2txt.m4 @@ -1,4 +1,21 @@ -# serial 1.1 +# serial 1.6.3 +dnl +dnl NDIM_DETECT_MAN2TXT +dnl +dnl Syntax: +dnl +dnl configure.ac: +dnl NDIM_DETECT_MAN2TXT()dnl +dnl +dnl Makefile.am: +dnl if HAVE_NDIM_MAN2TXT +dnl .txt.man: +dnl $(NDIM_MAN2TXT) $< > $@ +dnl endif +dnl +dnl Define AM_CONDITIONAL HAVE_NDIM_MAN2TXT. +dnl If that is true, define NDIM_MAN2TXT. +dnl m4_pattern_forbid([NDIM_DETECT_MAN2TXT])dnl AC_DEFUN([NDIM_DETECT_MAN2TXT], [dnl AC_ARG_VAR([MAN]) @@ -12,10 +29,12 @@ AM_CONDITIONAL([HAVE_NDIM_MAN2TXT], AC_MSG_CHECKING([man and col -b work correctly]) if test "x$HAVE_NDIM_MAN2TXT_FALSE" = "x#"; then AC_MSG_RESULT([yes]) - AC_SUBST([NDIM_MAN2TXT], ['m2t(){ $(MAN) "$$(dirname "$$][1")/$$(basename "$$][1")"|$(COL) -b; }; m2t'])dnl + NDIM_MAN2TXT='m2t(){ $(MAN) "$$(dirname "[$$]1")/$$(basename "[$$]1")"|$(COL) -b; }; m2t' else AC_MSG_RESULT([no $(echo "ABXY" | $COL -b)]) + NDIM_MAN2TXT='false' fi +AC_SUBST([NDIM_MAN2TXT]) ])dnl dnl dnl Local Variables: -- cgit