From 168b795f9eb12c08d70d05f2ee313165004564e3 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sun, 1 Jul 2007 17:55:44 -0400 Subject: Start addition of asciidoc stuff Add some asciidoc generation stuff to the doc/ Makefile.am so we can get some manpages up and working. Add necessary stuff to gitignore, and check in the asciidoc.conf file along with the footer for all of the manpages. Signed-off-by: Dan McGee --- doc/Makefile.am | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index 14caa0da..fd6fff45 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -10,7 +10,18 @@ if HAS_DOXYGEN man_MANS += $(wildcard man3/*.3) endif -EXTRA_DIST = $(man_MANS) Doxyfile +EXTRA_DIST = \ + pacman.8.txt \ + makepkg.8.txt \ + PKGBUILD.5.txt \ + makepkg.conf.5.txt \ + pacman.conf.5.txt \ + libalpm.3.txt \ + footer.txt \ + Doxyfile + +# Files that should be removed, but which Automake does not know. +MOSTLYCLEANFILES = $(man_MANS) man3/*.3 *.xml if HAS_DOXYGEN all: doxygen.in @@ -19,7 +30,7 @@ doxygen.in: doxygen $(srcdir)/Doxyfile endif -clean-local: - $(RM) man3/*.3 +$(man_MANS): + a2x -d manpage -f manpage --asciidoc-opts="-f asciidoc.conf" $@.txt # vim:set ts=2 sw=2 noet: -- cgit v1.2.3 From fe9a0de32edaf1db58e46a3fd3f1c05ad0b0e6c2 Mon Sep 17 00:00:00 2001 From: Andrew Fyfe Date: Fri, 6 Jul 2007 06:56:11 +0100 Subject: doc/Makefile.am: Set pacman version and date when man pages are generated. Signed-off-by: Andrew Fyfe --- doc/Makefile.am | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index fd6fff45..8c51a95a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -23,6 +23,11 @@ EXTRA_DIST = \ # Files that should be removed, but which Automake does not know. MOSTLYCLEANFILES = $(man_MANS) man3/*.3 *.xml +ASCIIDOC_OPTS = \ + -f asciidoc.conf \ + -apacman_version="$(PACKAGE_VERSION)" \ + -apacman_date="`date +%Y-%m-%d`" + if HAS_DOXYGEN all: doxygen.in @@ -31,6 +36,6 @@ doxygen.in: endif $(man_MANS): - a2x -d manpage -f manpage --asciidoc-opts="-f asciidoc.conf" $@.txt + a2x -d manpage -f manpage --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt # vim:set ts=2 sw=2 noet: -- cgit v1.2.3 From 499b750c2fbbedde27ad25d241f0c95566e5a0b7 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Fri, 6 Jul 2007 09:59:46 -0400 Subject: Make manpage generation depend on footer.txt If footer.txt is updated, we need to regenerate the manpages, this little fix should do this. Signed-off-by: Dan McGee --- doc/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index 8c51a95a..ab73b8d7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -35,7 +35,7 @@ doxygen.in: doxygen $(srcdir)/Doxyfile endif -$(man_MANS): +$(man_MANS): footer.txt a2x -d manpage -f manpage --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt # vim:set ts=2 sw=2 noet: -- cgit v1.2.3 From ab87657b937f3de392b1796e7f93c4008cc21f01 Mon Sep 17 00:00:00 2001 From: Andrew Fyfe Date: Fri, 6 Jul 2007 16:07:53 +0100 Subject: Add Synopsis section to man 5 pages. Signed-off-by: Andrew Fyfe --- doc/Makefile.am | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index ab73b8d7..a65f1cf7 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -25,8 +25,9 @@ MOSTLYCLEANFILES = $(man_MANS) man3/*.3 *.xml ASCIIDOC_OPTS = \ -f asciidoc.conf \ - -apacman_version="$(PACKAGE_VERSION)" \ - -apacman_date="`date +%Y-%m-%d`" + -a pacman_version="$(PACKAGE_VERSION)" \ + -a pacman_date="`date +%Y-%m-%d`" \ + -a sysconfdir=$(sysconfdir) if HAS_DOXYGEN all: doxygen.in -- cgit v1.2.3 From f1fac6abfb676b081ee2d474ab3e15f6d07d0416 Mon Sep 17 00:00:00 2001 From: Andrew Fyfe Date: Fri, 6 Jul 2007 16:30:53 +0100 Subject: Update PKGBUILD example. Signed-off-by: Andrew Fyfe --- doc/Makefile.am | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index a65f1cf7..308f338b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -14,6 +14,7 @@ EXTRA_DIST = \ pacman.8.txt \ makepkg.8.txt \ PKGBUILD.5.txt \ + PKGBUILD-example.txt \ makepkg.conf.5.txt \ pacman.conf.5.txt \ libalpm.3.txt \ @@ -39,4 +40,6 @@ endif $(man_MANS): footer.txt a2x -d manpage -f manpage --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt +PKGBUILD.5: PKGBUILD-example.txt + # vim:set ts=2 sw=2 noet: -- cgit v1.2.3 From e412ac19f549afa26b58dbd2a2090ed95ca9cb95 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Fri, 6 Jul 2007 16:54:18 -0400 Subject: Asciidoc updates- make it pretty, fix build, etc. * Fix up the target so we rebuild the manpages when we edit the corresponding text file. * Add vim modelines to all of the asciidoc files ensureing the right syntax highlighting is used and we have expandtabs turned off. * Start making a few small changes to PKGBUILD.5 to make it pretty in both HTML and manpage format output. * Fix the manlink macro to include the manpage section in the link. Signed-off-by: Dan McGee --- doc/Makefile.am | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index 308f338b..89f2a639 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -man_MANS = \ +ASCIIDOC_MANS = \ pacman.8 \ makepkg.8 \ PKGBUILD.5 \ @@ -6,6 +6,8 @@ man_MANS = \ pacman.conf.5 \ libalpm.3 +man_MANS = $(ASCIIDOC_MANS) + if HAS_DOXYGEN man_MANS += $(wildcard man3/*.3) endif @@ -37,9 +39,16 @@ doxygen.in: doxygen $(srcdir)/Doxyfile endif -$(man_MANS): footer.txt +$(ASCIIDOC_MANS): a2x -d manpage -f manpage --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt -PKGBUILD.5: PKGBUILD-example.txt +# These rules are due to the includes and files of the asciidoc text +$(ASCIIDOC_MANS): footer.txt +pacman.8: pacman.8.txt +makepkg.8: makepkg.8.txt +PKGBUILD.5: PKGBUILD.5.txt PKGBUILD-example.txt +makepkg.conf.5: makepkg.conf.5.txt +pacman.conf.5: pacman.conf.5.txt +libalpm.3: libalpm.3.txt # vim:set ts=2 sw=2 noet: -- cgit v1.2.3 From cd5b38a4b0e8cfe634b31fc730bddbc373eb17ce Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Mon, 9 Jul 2007 14:22:01 -0400 Subject: Add a manpage for repo-add We still need some work here- we should have a repo-remove manpage link to this one, and we should not have to struggle with asciidoc formatting to get it to work like any other multiple-command manpage works. Signed-off-by: Dan McGee --- doc/Makefile.am | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index 89f2a639..f790f585 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,6 +1,7 @@ ASCIIDOC_MANS = \ pacman.8 \ makepkg.8 \ + repo-add.8 \ PKGBUILD.5 \ makepkg.conf.5 \ pacman.conf.5 \ @@ -15,6 +16,7 @@ endif EXTRA_DIST = \ pacman.8.txt \ makepkg.8.txt \ + repo-add.8.txt \ PKGBUILD.5.txt \ PKGBUILD-example.txt \ makepkg.conf.5.txt \ @@ -46,6 +48,7 @@ $(ASCIIDOC_MANS): $(ASCIIDOC_MANS): footer.txt pacman.8: pacman.8.txt makepkg.8: makepkg.8.txt +repo-add.8: repo-add.8.txt PKGBUILD.5: PKGBUILD.5.txt PKGBUILD-example.txt makepkg.conf.5: makepkg.conf.5.txt pacman.conf.5: pacman.conf.5.txt -- cgit v1.2.3 From d2613b97fa8173920ef7440cf291ca24a05b5b7c Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Mon, 9 Jul 2007 14:38:02 -0400 Subject: Add asciidoc checking to configure.ac, make manpage generation optional Include manpages when we ship a package tarball, and allow them to be generated by the end user if they want by using the --enable-asciidoc option to ./configure. This will allow us to maintain manpages in an easier to modify format while still keeping the make dependencies to a minimum. Signed-off-by: Dan McGee --- doc/Makefile.am | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) (limited to 'doc/Makefile.am') diff --git a/doc/Makefile.am b/doc/Makefile.am index f790f585..ad251287 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -7,12 +7,12 @@ ASCIIDOC_MANS = \ pacman.conf.5 \ libalpm.3 -man_MANS = $(ASCIIDOC_MANS) - -if HAS_DOXYGEN -man_MANS += $(wildcard man3/*.3) +if USE_DOXYGEN +DOXYGEN_MANS = $(wildcard man3/*.3) endif +man_MANS = $(ASCIIDOC_MANS) $(DOXYGEN_MANS) + EXTRA_DIST = \ pacman.8.txt \ makepkg.8.txt \ @@ -23,24 +23,26 @@ EXTRA_DIST = \ pacman.conf.5.txt \ libalpm.3.txt \ footer.txt \ - Doxyfile + Doxyfile \ + $(ASCIIDOC_MANS) # Files that should be removed, but which Automake does not know. -MOSTLYCLEANFILES = $(man_MANS) man3/*.3 *.xml - -ASCIIDOC_OPTS = \ - -f asciidoc.conf \ - -a pacman_version="$(PACKAGE_VERSION)" \ - -a pacman_date="`date +%Y-%m-%d`" \ - -a sysconfdir=$(sysconfdir) +MOSTLYCLEANFILES = $(DOXYGEN_MANS) *.xml -if HAS_DOXYGEN +if USE_DOXYGEN all: doxygen.in doxygen.in: doxygen $(srcdir)/Doxyfile endif +if USE_ASCIIDOC +ASCIIDOC_OPTS = \ + -f asciidoc.conf \ + -a pacman_version="$(PACKAGE_VERSION)" \ + -a pacman_date="`date +%Y-%m-%d`" \ + -a sysconfdir=$(sysconfdir) + $(ASCIIDOC_MANS): a2x -d manpage -f manpage --asciidoc-opts="$(ASCIIDOC_OPTS)" $@.txt @@ -53,5 +55,6 @@ PKGBUILD.5: PKGBUILD.5.txt PKGBUILD-example.txt makepkg.conf.5: makepkg.conf.5.txt pacman.conf.5: pacman.conf.5.txt libalpm.3: libalpm.3.txt +endif # vim:set ts=2 sw=2 noet: -- cgit v1.2.3