Commit ba29891a authored by Alexandre Duret-Lutz's avatar Alexandre Duret-Lutz
Browse files

Distribute the HTML documentation.

	* Makefile.am (docs): Remove target.
	* doc/Makefile.am (docs): Rename this target as ...
	($(srcdir)/stamp): ... this, and update it whenever 
	configure.ac or doc.doxy.in change.
	(EXTRA_DIST): Distribute $(srcdir)/stamp and the 
	HTML documentation.
	(MAINTAINERCLEANFILES): Clean $(srcdir)/stamp.
	* doc/README.txt: Do not mention "make docs".  Reword a few
	paragraphs.
parent af384798
2007-10-05 Alexandre Duret-Lutz <adl@lrde.epita.fr>
Distribute the HTML documentation.
* Makefile.am (docs): Remove target.
* doc/Makefile.am (docs): Rename this target as ...
($(srcdir)/stamp): ... this, and update it whenever
configure.ac or doc.doxy.in change.
(EXTRA_DIST): Distribute $(srcdir)/stamp and the
HTML documentation.
(MAINTAINERCLEANFILES): Clean $(srcdir)/stamp.
* doc/README.txt: Do not mention "make docs". Reword a few
paragraphs.
2007-10-03 Guillaume Lazzara <z@lrde.epita.fr>
Disable TAF-Kit's tests related to are-isomorphic.
......
......@@ -81,10 +81,6 @@ maintainer-check:
deb:
$(MAKE) -C debian deb
# Build technical documentation
docs:
$(MAKE) -C doc docs
# Update headers.
rehead:
$(find_headers) | \
......
......@@ -16,6 +16,13 @@ include $(srcdir)/doc.mk
SUBDIRS = manual xml
all-local: $(srcdir)/stamp
# Run "make doc" to forcefully rebuild the Doxygen documentation.
.PHONY: doc
doc:
-rm -f $(srcdir)/stamp
$(MAKE) $(srcdir)/stamp
## ----------------------- ##
## Doxygen documentation. ##
......@@ -23,11 +30,17 @@ SUBDIRS = manual xml
DOCDIR = ref
DOXYFILE = doc.doxy
docs: $(DOXYFILE).in
rm -rf $(DOCDIR).tmp $(srcdir)/$(DOCDIR)
$(srcdir)/stamp: $(srcdir)/$(DOXYFILE).in $(top_srcdir)/configure.ac
-rm -rf $(DOCDIR).tmp
$(MAKE) $(AM_MAKEFLAGS) $(DOXYFILE)
$(DOXYGEN) $(DOXYFILE)
-rm -rf $(srcdir)/$(DOCDIR)
## FIXME: moving directories between file systems is not portable.
mv $(DOCDIR).tmp $(srcdir)/$(DOCDIR)
touch $(srcdir)/stamp
$(srcdir)/$(DOCDIR): $(srcdir)/stamp
# We install by hand, otherwise Automake produces "install .../srcdoc
# .../srcdoc", which installs our dir into the previous one, instead
......@@ -49,10 +62,10 @@ maintainer-clean-local:
## ----------------------- ##
dist_pdf_DATA = README.pdf FAQ.pdf NEWS.pdf
MAINTAINERCLEANFILES = $(dist_pdf_DATA)
MAINTAINERCLEANFILES = $(dist_pdf_DATA) $(srcdir)/stamp
EXTRA_DIST = README.tex FAQ.tex NEWS.tex \
share
share $(srcdir)/stamp $(srcdir)/$(DOCDIR)
# Do not distribute subversion and backup files from the share/ directory.
DIST_IGNORE = -name '*~' -o -name '.svn' -o -name '+committed'
......
......@@ -59,22 +59,25 @@ the command prompt::
./configure
make
make demos ([1]
make docs ([2])
make sanity-check
make check ([3])
make install (as root)
make install (as root)
Note that an installation is specific to the compiler used to install
it. Indeed, the call to ``./configure`` enables some workarounds and,
consequently, users must compile with the same compiler to avoid
compatibility problems.
[1]: Optional: Build demo binaries
[2]: Optional: Generate the technical documentation. Doxygen is
required on the system.
[3]: Optional: check the whole library. Note that this process takes
about 1.5 Go of free space (memory swap included) and several hours.
Between ``make`` and ``make install``, you may also want to run::
make demos
make sanity-check
make check
``make demos`` will build example binaries. ``make sanity-check``
will make sure that Vaucanson's header files can be included and
compiled. ``make check`` will run the test suite to check the whole
library. Running the test suite may require up to 1.5GB of free space
and several hours.
Additional features
-------------------
......@@ -91,7 +94,7 @@ To specify a special path for the Xerces-C library::
To specify a special path for the Boost-C++ library::
./configure --with-boost=/absolute/path/to/boost
./configure --with-boost=/absolute/path/to/boost
For further configure options, type::
......@@ -185,7 +188,7 @@ differ from the one used to build Vaucanson.
.. _Boost-C++: http://www.boost.org/
Dependency introduced since Vaucanson 1.1. Boost is a C++ library which
provides many useful objects, including hash tables. Currently, Boost
provides many useful objects, including hash tables. Currently, Boost
is used in algorithms only, but its use shall be extended to automata
structures and other portions of code.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment