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

Get rid of the FAQ

parent 162e55ae
2009-01-23 Alexandre Duret-Lutz <adl@lrde.epita.fr>
* doc/FAQ.txt: Delete. Of the three entries that was in this
FAQ two are obsolete (NAN and getopt), and one is not really a
FAQ.
(VCSN_DEFAULT_GRAPH_IMPL): Move this documentation ...
* doc/HACKING.txt: ... here.
* doc/README.txt: Do not mention de FAQ.
* doc/Makefile.am (EXTRA_DIST, dist_pdf_DATA): Update.
2009-01-23 Alexandre Duret-Lutz <adl@lrde.epita.fr>
 
* doc/README.txt: Remove the date as it hasn't been updated since
......
Vaucanson, a generic library for finite state machines.
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The Vaucanson Group.
Vaucanson, a generic library for finite state machines. Copyright (C)
2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The Vaucanson
Group.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
......@@ -15,8 +16,6 @@ The Vaucanson Group consists of people listed in the 'AUTHORS' file.
Vaucanson_ Frequently Asked Questions
=======================================
:Date: March 2006
Here are answers to different questions you may have while compiling
or using Vaucanson_.
......@@ -37,15 +36,6 @@ compiler, such as the `GNU Compiler Collection`_ version 3.3 or above.
.. _GNU Compiler Collection: http://gcc.gnu.org
I have a conflit declaration for ``int getopt()``.
--------------------------------------------------
The flag ``HAVE_DECL_GETOPT`` must be set. Compile with
``-DHAVE_DECL_GETOPT``. To use this flag with the script
``configure``, call it with::
configure CPPFLAGS='-DHAVE_DECL_GETOPT'
Usage issues
============
......
......@@ -103,7 +103,7 @@ Don't do these steps from memory.
- Make sure ``doc/NEWS.txt`` is up-to-date.
(Mention important known bugs!)
- Make sure ``doc/README.txt`` is up-to-date.
- Make sure ``doc/FAQ.txt`` is up-to-date.
- Make sure ``doc/HACKING.txt`` is up-to-date.
- Make sure AUTHORS is up-to-date.
......@@ -220,6 +220,26 @@ called ``libtool``, GNU ``libtool`` is usually installed as
``libtool`` output by ``configure`` at the root of Vaucanson's build
tree.
How can I choose a specific graph implementation?
-------------------------------------------------
Use ``configure``'s ``--with-default-graph-impl`` option to control
the default graph implementation of the library. The default is
``bmig`` (a graph represented using Boost Multi Indexes), the other
choice is ``listg`` (a graph represented using adjacency lists). For
instance if you want to compile Vaucanson using ``listg`` by default,
use::
./configure --with-default-graph-impl=listg
The Vaucanson libraries will be compiled with this default
implementation, but if you do not use these libraries you can switch
the default graph implementation at any time using the
``VCSN_DEFAULT_GRAPH_IMPL`` preprocessor macro, for instance::
make CPPFLAGS=-DVCSN_DEFAULT_GRAPH_IMPL=listg myprogram
.. Local Variables:
.. mode: rst
.. End:
## Vaucanson, a generic library for finite state machines.
## Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The Vaucanson Group.
## Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The Vaucanson Group.
##
## This program is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License
......@@ -98,7 +98,7 @@ maintainer-clean-local:
## RST documentation. ##
## ------------------- ##
dist_pdf_DATA = README.pdf FAQ.pdf HACKING.pdf NEWS.pdf
dist_pdf_DATA = README.pdf HACKING.pdf NEWS.pdf
MAINTAINERCLEANFILES = $(dist_pdf_DATA) $(srcdir)/stamp
TEXI2DVI = $(srcdir)/share/bin/texi2dvi
......@@ -117,7 +117,7 @@ SUFFIXES = .txt .tex .pdf
mv $@.tmp $@
EXTRA_DIST = README.txt FAQ.txt HACKING.txt NEWS.txt \
EXTRA_DIST = README.txt HACKING.txt NEWS.txt \
$(SHAREFILES) share/README $(srcdir)/stamp $(srcdir)/$(DOCDIR)
## ------------------ ##
......
......@@ -218,8 +218,6 @@ There are other sources of interest in the distribution.
- Headline news about the project can be found in the file ``NEWS`` at
the root of the source tree.
- Frequently asked questions are answered in the file ``FAQ``.
- The library reference manual, generated by Doxygen_, is located in
``doc/ref``.
......
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