using generic autotools description for all subprojects

git-svn-id: https://vsmartcard.svn.sourceforge.net/svnroot/vsmartcard@591 96b47cad-a561-4643-ad3b-153ac7d7599c

ccid/Makefile.am

@@ -1,2 +1,5 @@
 ACLOCAL_AMFLAGS = -I m4
 SUBDIRS = src m4 patches doc
+
+doc :
+	$(MAKE) doc -C $(srcdir)/doc

ccid/doc/Makefile.am

@@ -1 +1,20 @@
-EXTRA_DIST = README.rst
+do_subst = sed \
+	   -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \
+	   -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
+	   -e 's,[@]builddir[@],$(builddir),g' \
+	   -e 's,[@]prefix[@],$(prefix),g' \
+	   -e 's,[@]exec_prefix[@],$(exec_prefix),g' \
+	   -e 's,[@]libdir[@],$(libdir),g' \
+	   -e 's,[@]includedir[@],$(includedir),g' \
+	   -e 's,[@]VERSION[@],$(VERSION),g' \
+	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
+	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
+
+EXTRA_DIST = README.rst autotools.rst.in
+
+.PHONY: doc
+doc:
+	$(do_subst) < autotools.rst.in > autotools.rst
+
+clean-local:
+	rm -f autotools.rst

ccid/doc/README.rst

@@ -32,13 +32,7 @@ are based on the GadgetFS_ example and on the source code of the OpenSC_ tools.
 Installation
 =============
 
-ccid uses the GNU Build System to compile and install. If you are unfamiliar
+.. include:: autotools.rst
-with it, please have a look at the file :file:`INSTALL`. If you have a look around
-and can not find it, you are probably working bleeding edge in the repository.
-Run the following command in the npa directory to get the missing standard
-auxiliary files::
-    
-    autoreconf -i
 
 ccid as the following dependencies:
 

ccid/doc/autotools.rst.in

@@ -0,0 +1 @@
+../../doc/autotools.rst.in

doc/autotools.rst.in

@@ -0,0 +1,16 @@
+.. highlight:: sh
+
+@PACKAGE_NAME@ uses the GNU Build System to compile and install. If you are
+unfamiliar with it, please have a look at :file:`INSTALL`. If you have a look
+around and can not find it, you are probably working bleeding edge in the
+repository.  Run the following command in the @PACKAGE_NAME@ directory to get
+the missing standard auxiliary files::
+    
+    autoreconf -i
+
+To configure (:command:`configure --help` lists possible options), build and
+install @PACKAGE_NAME@ now do the following::
+    
+    ./configure
+    make
+    make install

doc/conf.py

@@ -12,7 +12,11 @@
 # serve to show the default.
 
 import sys, os, breathe
-from sphinxcontrib.doxylink import doxylink
+
+os.system("make doc -C npa >/dev/null")
+os.system("make doc -C virtualsmartcard >/dev/null")
+os.system("make doc -C ccid >/dev/null")
+os.system("make doc -C pcsc-relay >/dev/null")
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -215,9 +219,6 @@ man_pages = [
     ('index', 'virtualsmartcardarchitecture', u'Virtual Smartcard Architecture Documentation',
      [u'Dominik Oepen, Frank Morgner'], 1)
 ]
-
-os.system("make doc -C npa >/dev/null")
-os.system("make doc -C virtualsmartcard >/dev/null")
 breathe_projects = {"npa": "npa/xml"}
 breathe_default_project = "npa"
 doxylink = { 'npa' : ('npa/npa.tag', '_static/doxygen-npa/'), }

npa/Makefile.am

@@ -21,11 +21,8 @@ win:
 	    ./configure --disable-doc && \
 	    env OPENSSL_VERSION="1" OPENSSL_URL="https://www2.informatik.hu-berlin.de/~morgner/files/openssl-1.tar.gz" EXTRA_OPENSSL_CONFIG="experimental-pace" win32/installer_from_build.sh
 
-if DOC_ENABLED
-.PHONY: doc
 doc :
-	$(MAKE) doc -C doc
+	$(MAKE) doc -C $(srcdir)/doc
-endif
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = libnpa.pc

npa/doc/Makefile.am

@@ -1,5 +1,3 @@
-ACLOCAL_AMFLAGS = -I m4
-
 do_subst = sed \
 	   -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \
 	   -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
@@ -12,15 +10,14 @@ do_subst = sed \
 	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
 	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
 
-EXTRA_DIST = README.rst Doxyfile.in example.c
+EXTRA_DIST = README.rst Doxyfile.in example.c autotools.rst.in
 
-if DOC_ENABLED
 .PHONY: doc
 doc:
 	$(do_subst) < Doxyfile.in > Doxyfile
 	$(DOXYGEN) Doxyfile
 	touch api.rst
-endif
+	$(do_subst) < autotools.rst.in > autotools.rst
 
 clean-local:
-	rm -f Doxyfile
+	rm -f Doxyfile autotools.rst

npa/doc/README.rst

@@ -35,13 +35,7 @@ APDUs inside a secure messaging channel established with PACE.
 Installation
 ============
 
-npa uses the GNU Build System to compile and install. If you are unfamiliar
+.. include:: autotools.rst
-with it, please have a look at file:`INSTALL`. If you have a look around
-and can not find it, you are probably working bleeding edge in the repository.
-Run the following command in the npa directory to get the missing standard
-auxiliary files::
-    
-    autoreconf -i
 
 npa has the following dependencies:
 

npa/doc/autotools.rst.in

@@ -0,0 +1 @@
+../../doc/autotools.rst.in

pcsc-relay/Makefile.am

@@ -1 +1,4 @@
 SUBDIRS = src doc
+
+doc :
+	$(MAKE) doc -C $(srcdir)/doc

pcsc-relay/doc/Makefile.am

@@ -1 +1,20 @@
-EXTRA_DIST = README.rst
+do_subst = sed \
+	   -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \
+	   -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
+	   -e 's,[@]builddir[@],$(builddir),g' \
+	   -e 's,[@]prefix[@],$(prefix),g' \
+	   -e 's,[@]exec_prefix[@],$(exec_prefix),g' \
+	   -e 's,[@]libdir[@],$(libdir),g' \
+	   -e 's,[@]includedir[@],$(includedir),g' \
+	   -e 's,[@]VERSION[@],$(VERSION),g' \
+	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
+	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
+
+EXTRA_DIST = README.rst autotools.rst.in
+
+.PHONY: doc
+doc:
+	$(do_subst) < autotools.rst.in > autotools.rst
+
+clean-local:
+	rm -f autotools.rst

pcsc-relay/doc/README.rst

@@ -26,13 +26,7 @@ ISO/IEC 14443 smart card.
 Installation
 ============
 
-pcsc-relay uses the GNU Build System to compile and install. If you are
+.. include:: autotools.rst
-unfamiliar with it, please have a look at the file :file:`INSTALL`. If you have a
-look around and can not find it, you are probably working bleeding edge in the
-repository.  Run the following command in the pcsc-relay directory to get the
-missing standard auxiliary files::
-    
-    autoreconf -i
 
 pcsc-relay has the following dependencies:
 

pcsc-relay/doc/autotools.rst.in

@@ -0,0 +1 @@
+../../doc/autotools.rst.in

virtualsmartcard/Makefile.am

@@ -1,5 +1,4 @@
 SUBDIRS = src doc
 
-.PHONY: doc
 doc:
-	$(MAKE) doc -C doc
+	$(MAKE) doc -C $(srcdir)/doc

virtualsmartcard/doc/Makefile.am

@@ -1,8 +1,21 @@
-EXTRA_DIST = README.rst generate_modules.py api
+do_subst = sed \
+	   -e 's,[@]PACKAGE_NAME[@],$(PACKAGE_NAME),g' \
+	   -e 's,[@]PACKAGE_VERSION[@],$(PACKAGE_VERSION),g' \
+	   -e 's,[@]builddir[@],$(builddir),g' \
+	   -e 's,[@]prefix[@],$(prefix),g' \
+	   -e 's,[@]exec_prefix[@],$(exec_prefix),g' \
+	   -e 's,[@]libdir[@],$(libdir),g' \
+	   -e 's,[@]includedir[@],$(includedir),g' \
+	   -e 's,[@]VERSION[@],$(VERSION),g' \
+	   -e 's,[@]OPENSC_LIBS[@],$(OPENSC_LIBS),g' \
+	   -e 's,[@]top_srcdir[@],$(top_srcdir),g'
+
+EXTRA_DIST = README.rst generate_modules.py api autotools.rst.in
 
 .PHONY: doc
 doc:
+	$(do_subst) < autotools.rst.in > autotools.rst
 	./generate_modules.py $(top_srcdir)/src/vpicc --dest-dir=api --suffix=rst --no-toc -1
 
 clean-local:
-	rm -rf api/*
+	rm -rf api/* autotools.rst

virtualsmartcard/doc/README.rst

@@ -43,13 +43,7 @@ cyberflex-shell_.
 Installation
 ------------
 
-virtualsmartcard uses the GNU Build System to compile and install. If you are
+.. include:: autotools.rst
-unfamiliar with it, please have a look at the file :file:`INSTALL`. If you have a
-look around and can not find it, you are probably working bleeding edge in the
-repository.  Run the following command in the virtualsmartcard directory to get
-the missing standard auxiliary files::
-    
-    autoreconf -i
 
 Depending on your usage of the |vpicc| you might or might not need
 the following:

virtualsmartcard/doc/autotools.rst.in

@@ -0,0 +1 @@
+../../doc/autotools.rst.in