Menu
▾
▴
[Stdair-svn] SF.net SVN: stdair:[249] trunk/stdair/doc
|
From: <den...@us...> - 2010-08-01 16:17:32
|
Revision: 249
http://stdair.svn.sourceforge.net/stdair/?rev=249&view=rev
Author: denis_arnaud
Date: 2010-08-01 16:17:26 +0000 (Sun, 01 Aug 2010)
Log Message:
-----------
[Doc] Improved the documentation a little bit.
Modified Paths:
--------------
trunk/stdair/doc/Makefile.am
trunk/stdair/doc/doxygen_html.cfg.in
trunk/stdair/doc/local/codingrules.doc
trunk/stdair/doc/local/documentation.doc
trunk/stdair/doc/local/help_wanted.doc
trunk/stdair/doc/local/howto_release.doc
trunk/stdair/doc/local/installation.doc
trunk/stdair/doc/local/linking.doc
trunk/stdair/doc/local/stdair_footer.html
trunk/stdair/doc/local/stdair_header.html
Removed Paths:
-------------
trunk/stdair/doc/sourceforge/
Modified: trunk/stdair/doc/Makefile.am
===================================================================
--- trunk/stdair/doc/Makefile.am 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/Makefile.am 2010-08-01 16:17:26 UTC (rev 249)
@@ -17,9 +17,8 @@
html_tarname = @PACKAGE_TARNAME@-doc-@PACKAGE_VERSION@
pdf_tarname = @PACKAGE_TARNAME@-pdf-@PACKAGE_VERSION@
-#noinst_DATA = sourceforge/howto_release_stdair.html.in
-#EXTRA_DIST = $(noinst_DATA)
-EXTRA_DIST =
+noinst_DATA =
+EXTRA_DIST = $(noinst_DATA)
# Targets
all-local: html-local
Modified: trunk/stdair/doc/doxygen_html.cfg.in
===================================================================
--- trunk/stdair/doc/doxygen_html.cfg.in 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/doxygen_html.cfg.in 2010-08-01 16:17:26 UTC (rev 249)
@@ -126,7 +126,7 @@
STRIP_FROM_INC_PATH = @top_srcdir@/
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
-# (but less readable) file names. This can be useful is your file systems
+# (but less readable) file names. This can be useful if your file systems
# doesn't support long names like on DOS, Mac, or CD-ROM.
SHORT_NAMES = NO
@@ -576,7 +576,6 @@
INPUT = @top_srcdir@/@PACKAGE@ \
@top_srcdir@/doc/local \
- @top_builddir@/doc/local \
@top_srcdir@/doc/tutorial
# This tag can be used to specify the character encoding of the source files
@@ -1353,13 +1352,13 @@
# When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads.
-GENERATE_TAGFILE = doxygen_html.tag
+GENERATE_TAGFILE = html/doxygen_@PACKAGE@.tag
# If the ALLEXTERNALS tag is set to YES all external classes will be listed
# in the class index. If set to NO only the inherited external classes
# will be listed.
-ALLEXTERNALS = NO
+ALLEXTERNALS = YES
# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
# in the modules index. If set to NO, only the current project's groups will
Modified: trunk/stdair/doc/local/codingrules.doc
===================================================================
--- trunk/stdair/doc/local/codingrules.doc 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/codingrules.doc 2010-08-01 16:17:26 UTC (rev 249)
@@ -9,14 +9,14 @@
Variables names follow Java naming conventions.
Examples:
-- \c `lNumberOfPassengers'
-- \c `lSeatAvailability'
+- \c lNumberOfPassengers
+- \c lSeatAvailability
\section cr_functions Default Naming Rules for Functions
Function names follow Java naming conventions. Example:
-- \c `int \c myFunctionName (\c const \c int& \c a, \c int \c b)'
+- <tt>int myFunctionName (const int& a, int b)</tt>
\section cr_classes Default Naming Rules for Classes and Structures
@@ -24,18 +24,18 @@
Each new word in a class or structure name should always start with a
capital letter and the words should be separated with an
under-score. Abbreviations are written with capital letters. Examples:
-- \c `MyClassName'
-- \c `MyStructName'
+- \c MyClassName
+- \c MyStructName
\section cr_files Default Naming Rules for Files
Files are named after the C++ class names.
-Source files are named using \c `.cpp' suffix, whereas header
-files end with \c `.hpp' extension. Examples:
-- \c `FlightDate.hpp'
-- \c `SegmentDate.cpp'
+Source files are named using <tt>.cpp</tt> suffix, whereas header
+files end with <tt>.hpp</tt> extension. Examples:
+- <tt>FlightDate.hpp</tt>
+- <tt>SegmentDate.cpp</tt>
Modified: trunk/stdair/doc/local/documentation.doc
===================================================================
--- trunk/stdair/doc/local/documentation.doc 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/documentation.doc 2010-08-01 16:17:26 UTC (rev 249)
@@ -4,9 +4,9 @@
\section doc_general General Rules
All classes in StdAir should be properly documented with Doxygen
-comments in include (\c `.hpp') files. Source (\c `.cpp') files should be
-documented according to a normal standard for well documented C++
-code.
+comments in include (<tt>.hpp</tt>) files. Source (<tt>.cpp</tt>)
+files should be documented according to a normal standard for well
+documented C++ code.
An example of how the interface of a class shall be documented in StdAir
is shown here:
@@ -75,32 +75,18 @@
* \file
* \brief Brief description of the file here
* \author Names of the authors who contributed to this code
+ * \date Date
*
* Detailed description of the file here if needed.
*
- * $Date: 2005-12-13 12:27:39 +0100 (mar, 13 déc 2005) $
- * $Revision: 93 $
- *
* -------------------------------------------------------------------------
*
* StdAir - C++ Standard Airline IT Object Library
*
* Copyright (C) 2009-2010 (see AUTHORS file for a list of contributors)
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published
- * by the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * See COPYING file for license information
*
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- *
* -------------------------------------------------------------------------
*/
\endverbatim
@@ -121,8 +107,8 @@
\endverbatim
-The following example shows how to document the function \c
-`myFunction' and how to add it to the group \c `my_group':
+The following example shows how to document the function \c myFunction
+and how to add it to the group \c my_group:
\verbatim
/*!
Modified: trunk/stdair/doc/local/help_wanted.doc
===================================================================
--- trunk/stdair/doc/local/help_wanted.doc 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/help_wanted.doc 2010-08-01 16:17:26 UTC (rev 249)
@@ -21,7 +21,7 @@
- Help us to port StdAir to new platforms. If you manage to compile StdAir on a
new platform, then tell us how you did it.
- Send us your code. If you have a good StdAir compatible code, which you can
-release under the GPL, and you think it should be included in StdAir, then
+release under the LGPL, and you think it should be included in StdAir, then
send it to us.
- Become an StdAir developer. Send us an e-mail and tell what you can do for
StdAir.
Modified: trunk/stdair/doc/local/howto_release.doc
===================================================================
--- trunk/stdair/doc/local/howto_release.doc 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/howto_release.doc 2010-08-01 16:17:26 UTC (rev 249)
@@ -51,11 +51,11 @@
Check to which Subversion revision the release corresponds to. For instance
the <a href="http://sourceforge.net/apps/trac/stdair/changeset/233/">StdAir
release 0.2.0 corresponds to Subversion revision r233</a>.
-The trunk \c configure.ac file specifies a fake release number, namely
+The trunk <tt>configure.ac</tt> file specifies a fake release number, namely
99.99.99,
for current (head) development. When a release is made, two Subversion
revisions are committed with, as the sole change, the release number within
-the \c configure.ac file:
+the <tt>configure.ac</tt> file:
- one revision is committed with the to-be-released version number (e.g.,
0.2.0) and commit message prefixed with "[Release x.y.z]",
- and another one with the release number back to 99.99.99 and message stating
@@ -127,7 +127,8 @@
This will configure, compile and check the package. The output packages will
-be named, for instance, \c stdair-0.2.0.tar.gz and \c stdair-0.2.0.tar.bz2.
+be named, for instance, <tt>stdair-0.2.0.tar.gz</tt> and
+<tt>stdair-0.2.0.tar.bz2</tt>.
\section generate_rpm_packages Generation the RPM packages
@@ -164,13 +165,13 @@
\section create_doc_packages Create the documentation packages
Create the documentation packages using the following command:
-\c make dist-html and \c make dist-tex
+<tt>make dist-html</tt> and <tt>make dist-tex</tt>
The output documentation packages will be named, for instance:
-- \c stdair-doc-0.2.0.tar.gz and \c stdair-doc-0.2.0.tar.bz2 for the
- HTML documentation.
-- \c stdair-pdf-0.2.0.tar.gz and \c stdair-pdf-0.2.0.tar.bz2 for the
- PDF documentation.
+- <tt>stdair-doc-0.2.0.tar.gz</tt> and <tt>stdair-doc-0.2.0.tar.bz2</tt>
+ for the HTML documentation.
+- <tt>stdair-pdf-0.2.0.tar.gz</tt> and <tt>stdair-pdf-0.2.0.tar.bz2</tt>
+ for the PDF documentation.
\section upload_files Upload the files to SourceForge
@@ -187,23 +188,31 @@
\verbatim
cd ~/dev
cd stdairsvn/branches/stdair/0.2.0/main
-rsync -aiv doc/html joe,st...@we...:htdocs/
+rsync -aiv doc/html/ joe,st...@we...:htdocs/
\endverbatim
where \c -aiv options mean:
- \c -a: archive/mirror mode; equals \c -rlptgoD
(no \c -H, \c -A, \c -X)
- \c -v: increase verbosity
- \c -i: output a change-summary for all updates
+ - Note the trailing slashes (/) at the end of both the source and target
+ directories. It means that the content of the source directory
+ (<tt>doc/html</tt>), rather than the directory itself, has to be copied
+ into the content of the target directory.
- or use the
<a href="https://sourceforge.net/apps/trac/sourceforge/wiki/Shell%20service">SourceForge Shell service</a>.
\section post_news Make a new post
-- submit a new entry in the <a href="https://sourceforge.net/news/submit.php?group_id=267760">SourceForge project-related news feed</a>
-- make a new post on the <a href="https://sourceforge.net/apps/wordpress/stdair/wp-admin/">SourceForge hosted WordPress blog</a>
+- submit a new entry in the
+ <a href="https://sourceforge.net/news/submit.php?group_id=267760">SourceForge
+ project-related news feed</a>
+- make a new post on the
+ <a href="https://sourceforge.net/apps/wordpress/stdair/wp-admin/">SourceForge
+ hosted WordPress blog</a>
- and update, if necessary,
-<a href="https://sourceforge.net/apps/trac/stdair/report">Trac tickets</a>.
+ <a href="https://sourceforge.net/apps/trac/stdair/report">Trac tickets</a>.
\section send_announce Send an email on the announcement mailing-list
Modified: trunk/stdair/doc/local/installation.doc
===================================================================
--- trunk/stdair/doc/local/installation.doc 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/installation.doc 2010-08-01 16:17:26 UTC (rev 249)
@@ -69,7 +69,7 @@
\section basic_instructions Basic Installation
- Briefly, the shell commands \c `./configure; make; make install'
+ Briefly, the shell commands <tt>`./configure; make; make install'</tt>
should configure, build, and install this package. The following
more-detailed instructions are generic; see the \c `README' file for
instructions specific to this package. Some packages provide this
@@ -101,53 +101,56 @@
some point \c `config.cache' contains results you don't want to keep, you
may remove or edit it.
- The file \c `configure.ac' (or \c `configure.in') is used to create
-\c `configure' by a program called \c `autoconf'. You need \c `configure.ac'
-if you want to change it or regenerate \c `configure' using a newer version
-of \c `autoconf'.
+ The file <tt>`configure.ac'</tt> (or <tt>`configure.in'</tt>) is
+used to create \c `configure' by a program called \c `autoconf'. You
+need <tt>`configure.ac'</tt> if you want to change it or regenerate \c
+`configure' using a newer version of \c `autoconf'.
The simplest way to compile this package is:
--# \c `cd' to the directory containing the package's source code and type
- \c `./configure' to configure the package for your system.
- Running \c `configure' might take a while. While running, it prints
- some messages telling which features it is checking for.
+-# \c `cd' to the directory containing the package's source code and
+ type <tt>`./configure'</tt> to configure the package for your
+ system. Running \c `configure' might take a while. While running,
+ it prints some messages telling which features it is checking for.
-# Type \c `make' to compile the package.
--# Optionally, type \c `make check' to run any self-tests that come with
- the package, generally using the just-built uninstalled binaries.
--# Type \c `make install' to install the programs and any data files and
- documentation. When installing into a prefix owned by root, it is
- recommended that the package be configured and built as a regular
- user, and only the `make install' phase executed with root
- privileges.
--# Optionally, type \c `make installcheck' to repeat any self-tests, but
- this time using the binaries in their final installed location.
- This target does not install anything. Running this target as a
- regular user, particularly if the prior \c `make install' required
- root privileges, verifies that the installation completed
- correctly.
+-# Optionally, type <tt>`make check'<tt> to run any self-tests that
+ come with the package, generally using the just-built uninstalled
+ binaries.
+-# Type <tt>`make install'</tt> to install the programs and any data
+ files and documentation. When installing into a prefix owned by
+ root, it is recommended that the package be configured and built as
+ a regular user, and only the `make install' phase executed with
+ root privileges.
+-# Optionally, type <tt>`make installcheck'</tt> to repeat any
+ self-tests, but this time using the binaries in their final
+ installed location. This target does not install anything.
+ Running this target as a regular user, particularly if the prior
+ <tt>`make install'</tt> required root privileges, verifies that the
+ installation completed correctly.
-# You can remove the program binaries and object files from the
- source code directory by typing \c `make clean'. To also remove the
- files that \c `configure' created (so you can compile the package for
- a different kind of computer), type \c `make distclean'. There is
- also a \c `make maintainer-clean' target, but that is intended mainly
- for the package's developers. If you use it, you may have to get
- all sorts of other programs in order to regenerate files that came
- with the distribution.
--# Often, you can also type \c `make uninstall' to remove the installed
+ source code directory by typing <tt>`make clean'</tt>. To also
+ remove the files that \c `configure' created (so you can compile
+ the package for a different kind of computer), type <tt>`make
+ distclean'</tt>. There is also a <tt>`make maintainer-clean'</tt>
+ target, but that is intended mainly for the package's developers.
+ If you use it, you may have to get all sorts of other programs in
+ order to regenerate files that came with the distribution.
+-# Often, you can also type <tt>`make uninstall'</tt> to remove the installed
files again. In practice, not all packages have tested that
uninstallation works correctly, even though it is required by the
GNU Coding Standards.
--# Some packages, particularly those that use Automake, provide \c `make
- distcheck', which can by used by developers to test that all other
- targets like \c `make install' and \c `make uninstall' work correctly.
- This target is generally not run by end users.
+-# Some packages, particularly those that use Automake, provide
+ <tt>`make distcheck'</tt>, which can by used by developers to test
+ that all other targets like <tt>`make install'</tt> and <tt>`make
+ uninstall'</tt> work correctly. This target is generally not run
+ by end users.
\section compilers Compilers and Options
- Some systems require unusual options for compilation or linking that
-the \c `configure' script does not know about. Run \c `./configure --help'
-for details on some of the pertinent environment variables.
+ Some systems require unusual options for compilation or linking
+that the \c `configure' script does not know about. Run
+<tt>`./configure --help'</tt> for details on some of the pertinent
+environment variables.
You can give \c `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
@@ -157,7 +160,7 @@
./configure CC=c99 CFLAGS=-g LIBS=-lposix
\endverbatim
- *Note \ref defining_variables for more details.
+ \see \ref defining_variables for more details.
\section compiling_for_multi_arch Compiling For Multiple Architectures
@@ -168,9 +171,9 @@
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'. This
-is known as a "VPATH" build.
+is known as a \c "VPATH" build.
- With a non-GNU `make', it is safer to compile the package for one
+ With a non-GNU \c `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
@@ -194,79 +197,85 @@
\section installation_names Installation Names
- By default, \c `make install' installs the package's commands under
-\c `/usr/local/bin', include files under \c `/usr/local/include', etc. You
-can specify an installation prefix other than \c `/usr/local' by giving
-\c `configure' the option \c `--prefix=PREFIX', where \c PREFIX must be an
-absolute file name.
+ By default, <tt>`make install'</tt> installs the package's commands
+under <tt>`/usr/local/bin'</tt>, include files under
+<tt>`/usr/local/include'</tt>, etc. You can specify an installation
+prefix other than <tt>`/usr/local'</tt> by giving \c `configure' the
+option <tt>`--prefix=PREFIX'</tt>, where \c PREFIX must be an absolute
+file name.
You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files. If you
-pass the option \c `--exec-prefix=PREFIX' to `configure', the package uses
-\c PREFIX as the prefix for installing programs and libraries.
-Documentation and other data files still use the regular prefix.
+architecture-specific files and architecture-independent files. If
+you pass the option <tt>`--exec-prefix=PREFIX'</tt> to `configure',
+the package uses \c PREFIX as the prefix for installing programs and
+libraries. Documentation and other data files still use the regular
+prefix.
In addition, if you use an unusual directory layout you can give
-options like \c `--bindir=DIR' to specify different values for particular
-kinds of files. Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them. In general, the
-default for these options is expressed in terms of \c `${prefix}', so that
-specifying just \c `--prefix' will affect all of the other directory
-specifications that were not explicitly provided.
+options like <tt>`--bindir=DIR'</tt> to specify different values for
+particular kinds of files. Run `configure --help' for a list of the
+directories you can set and what kinds of files go in them. In
+general, the default for these options is expressed in terms of
+<tt>`${prefix}'</tt>, so that specifying just <tt>`--prefix'</tt> will
+affect all of the other directory specifications that were not
+explicitly provided.
- The most portable way to affect installation locations is to pass the
-correct locations to \c `configure'; however, many packages provide one or
-both of the following shortcuts of passing variable assignments to the
-\c `make install' command line to change installation locations without
-having to reconfigure or recompile.
+ The most portable way to affect installation locations is to pass
+the correct locations to \c `configure'; however, many packages
+provide one or both of the following shortcuts of passing variable
+assignments to the <tt>`make install'</tt> command line to change
+installation locations without having to reconfigure or recompile.
The first method involves providing an override variable for each
-affected directory. For example,
-\c `make install prefix=/alternate/directory' will choose an alternate location
-for all directory configuration variables that were expressed in terms of
-\c `${prefix}'. Any directories that were specified during \c `configure',
-but not in terms of \c `${prefix}', must each be overridden at install
-time for the entire installation to be relocated. The approach of
-makefile variable overrides for each directory variable is required by
-the GNU Coding Standards, and ideally causes no recompilation.
-However, some platforms have known limitations with the semantics of
-shared libraries that end up requiring recompilation when using this
-method, particularly noticeable in packages that use GNU Libtool.
+affected directory. For example, <tt>`make install
+prefix=/alternate/directory'</tt> will choose an alternate location
+for all directory configuration variables that were expressed in terms
+of <tt>`${prefix}'</tt>. Any directories that were specified during
+\c `configure', but not in terms of <tt>`${prefix}'</tt>, must each be
+overridden at install time for the entire installation to be
+relocated. The approach of makefile variable overrides for each
+directory variable is required by the GNU Coding Standards, and
+ideally causes no recompilation. However, some platforms have known
+limitations with the semantics of shared libraries that end up
+requiring recompilation when using this method, particularly
+noticeable in packages that use GNU Libtool.
- The second method involves providing the \c `DESTDIR' variable. For
-example, \c `make install DESTDIR=/alternate/directory' will prepend
-\c `/alternate/directory' before all installation names. The approach of
-\c `DESTDIR' overrides is not required by the GNU Coding Standards, and
-does not work on platforms that have drive letters. On the other hand,
-it does better at avoiding recompilation issues, and works well even
-when some directory options were not specified in terms of \c `${prefix}'
-at \c `configure' time.
+ The second method involves providing the \c `DESTDIR' variable.
+For example, <tt>`make install DESTDIR=/alternate/directory'</tt> will
+prepend <tt>`/alternate/directory'</tt> before all installation names.
+The approach of \c `DESTDIR' overrides is not required by the GNU
+Coding Standards, and does not work on platforms that have drive
+letters. On the other hand, it does better at avoiding recompilation
+issues, and works well even when some directory options were not
+specified in terms of <tt>`${prefix}'</tt> at \c `configure' time.
\section optional_features Optional Features
If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving \c `configure' the
-option \c `--program-prefix=PREFIX' or \c `--program-suffix=SUFFIX'.
+with an extra prefix or suffix on their names by giving \c `configure'
+the option <tt>`--program-prefix=PREFIX'</tt> or
+<tt>`--program-suffix=SUFFIX'</tt>.
- Some packages pay attention to \c `--enable-FEATURE' options to
-\c `configure', where \c FEATURE indicates an optional part of the package.
-They may also pay attention to \c `--with-PACKAGE' options, where \c PACKAGE
-is something like \c `gnu-as' or \c `x' (for the X Window System). The
-\c `README' should mention any \c `--enable-' and \c `--with-' options that
-the package recognizes.
+ Some packages pay attention to <tt>`--enable-FEATURE'</tt> options
+to \c `configure', where \c FEATURE indicates an optional part of the
+package. They may also pay attention to <tt>`--with-PACKAGE'</tt>
+options, where \c PACKAGE is something like <tt>`gnu-as'</tt> or \c
+`x' (for the X Window System). The \c `README' should mention any
+<tt>`--enable-'</tt> and <tt>`--with-'</tt> options that the package
+recognizes.
For packages that use the X Window System, \c `configure' can usually
find the X include and library files automatically, but if it doesn't,
-you can use the \c `configure' options \c `--x-includes=DIR' and
-\c `--x-libraries=DIR' to specify their locations.
+you can use the \c `configure' options <tt>`--x-includes=DIR'</tt> and
+<tt>`--x-libraries=DIR'</tt> to specify their locations.
Some packages offer the ability to configure how verbose the
-execution of `make' will be. For these packages, running \c `./configure
---enable-silent-rules' sets the default to minimal output, which can be
-overridden with \c `make V=1'; while running \c `./configure
---disable-silent-rules' sets the default to verbose, which can be
-overridden with \c `make V=0'.
+execution of `make' will be. For these packages, running <tt>`./configure
+--enable-silent-rules'</tt> sets the default to minimal output, which can be
+overridden with <tt>`make V=1'</tt>; while running <tt>`./configure
+--disable-silent-rules'</tt> sets the default to verbose, which can be
+overridden with <tt>`make V=0'</tt>.
\section particular_systems Particular systems
@@ -281,10 +290,10 @@
and if that doesn't work, install pre-built binaries of GCC for HP-UX.
- On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
-parse its \c `<wchar.h>' header file. The option \c `-nodtk' can be used as
-a workaround. If GNU CC is not installed, it is therefore recommended
-to try
+ On OSF/1 a.k.a. Tru64, some versions of the default C compiler
+cannot parse its <tt>`<wchar.h>'</tt> header file. The option
+<tt>`-nodtk'</tt> can be used as a workaround. If GNU CC is not
+installed, it is therefore recommended to try
\verbatim
./configure CC="cc"
@@ -375,31 +384,35 @@
\c `configure' recognizes the following options to control how it
operates.
-- \c `--help', \c `-h' print a summary of all of the options to `configure',
- and exit.
-- \c `--help=short', \c `--help=recursive' print a summary of the options
- unique to this package's \c `configure', and exit.
+- <tt>`--help'</tt>, \c `-h' print a summary of all of the options to
+ `configure', and exit.
+- <tt>`--help=short'</tt>, <tt>`--help=recursive'</tt> print a summary
+ of the options unique to this package's \c `configure', and exit.
The \c `short' variant lists options used only in the top level, while
the \c `recursive' variant lists options also present in any nested packages.
-- \c `--version', `-V' print the version of Autoconf used to generate
+- <tt>`--version'</tt>, `-V' print the version of Autoconf used to generate
the `configure' script, and exit.
-- \c `--cache-file=FILE' enable the cache: use and save the results of the
- tests in \c FILE, traditionally \c `config.cache'.
- \c FILE defaults to \c `/dev/null' to disable caching.
-- \c `--config-cache', \c `-C' alias for \c `--cache-file=config.cache'.
-- \c `--quiet', \c `--silent', \c `-q' do not print messages saying which
- checks are being made. To suppress all normal output, redirect it to
- `/dev/null' (any error messages will still be shown).
-- \c `--srcdir=DIR' look for the package's source code in directory \c DIR.
- Usually \c `configure' can determine that directory automatically.
-- \c `--prefix=DIR' use \c DIR as the installation prefix.
- *note \ref installation_names for more details, including other options
+- <tt>`--cache-file=FILE'</tt> enable the cache: use and save the
+ results of the tests in \c FILE, traditionally
+ <tt>`config.cache'</tt>.
+ \c FILE defaults to <tt>`/dev/null'</tt> to disable caching.
+- <tt>`--config-cache'</tt>, \c `-C' alias for
+ <tt>`--cache-file=config.cache'</tt>.
+- <tt>`--quiet'</tt>, <tt>`--silent'</tt>, \c `-q' do not print
+ messages saying which checks are being made. To suppress all normal
+ output, redirect it to <tt>`/dev/null'</tt> (any error messages will
+ still be shown).
+- <tt>`--srcdir=DIR'</tt> look for the package's source code in
+ directory \c DIR. Usually \c `configure' can determine that
+ directory automatically.
+- <tt>`--prefix=DIR'</tt> use \c DIR as the installation prefix.
+ \see \ref installation_names for more details, including other options
available for fine-tuning the installation locations.
--c \c `--no-create', \c `-n' run the configure checks, but stop before creating
- any output files.
+- <tt>`--no-create'</tt>, \c `-n' run the configure checks, but stop
+ before creating any output files.
\c `configure' also accepts some other, not widely useful, options. Run
-\c `configure --help' for more details.
+<tt>`configure --help'</tt> for more details.
The \c `configure' script produces an ouput like this:
@@ -481,9 +494,9 @@
\endverbatim
It is recommended that you check if your library has been compiled and
-linked properly and works as expected. To do so, you should execute the
-testing process \c `make check'. As a result, you should obtain a similar
-report:
+linked properly and works as expected. To do so, you should execute
+the testing process <tt>`make check'</tt>. As a result, you should
+obtain a similar report:
\verbatim
[...]
@@ -519,7 +532,7 @@
and (optionally) HTML and PDF documentation by typing:
\verbatim
-% make install
+make install
\endverbatim
Depending on the \c PREFIX settings during configuration, you might need
Modified: trunk/stdair/doc/local/linking.doc
===================================================================
--- trunk/stdair/doc/local/linking.doc 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/linking.doc 2010-08-01 16:17:26 UTC (rev 249)
@@ -5,6 +5,7 @@
- \ref intro
- \ref pkgconfig
- \ref stdair_config
+- \ref autotools
- \ref dynamiclinking
@@ -53,23 +54,6 @@
g++ `stdair-config --cflags` -o my_prog my_prog.cpp `stdair-config --libs`
\endcode
-If you would like to use the same optimisation flags (\c CXXFLAGS), as those
-used for compiling the StdAir library, you might try the following command:
-
-\code
-g++ `stdair-config --cflags-opt` -o my_prog_opt my_prog.cpp \
- `stdair-config --libs-opt`
-\endcode
-
-Moreover, if you compiled and installed the \c `libstdair_debug.*' library by
-using \c `--enable-debug' swich to configure, you can compile and link your
-program with debugging options using the following command instead:
-
-\code
-g++ `stdair-config --cflags-debug` -o my_prog_debug my_prog.cpp \
- `stdair-config --libs-debug`
-\endcode
-
A list of \c `stdair-config' options can be obtained by typing:
\code
@@ -84,6 +68,19 @@
\endcode
+\section autotools M4 macro for the GNU Autotools
+
+A M4 macro file is delivered with StdAir, namely `stdair.m4', which
+can be found in, e.g., `/usr/share/aclocal'. When used by a
+`configure' script, thanks to he <tt>`AM_PATH_STDAIR'</tt> macro
+(specified in the M4 macro file), the following Makefile variables are
+then defined:
+- <tt>`STDAIR_VERSION'</tt> (e.g., defined to 0.2.0)
+- <tt>`STDAIR_CFLAGS'</tt> (e.g., defined to <tt>`-I${prefix}/include'</tt>)
+- <tt>`STDAIR_LIBS'</tt> (e.g., defined to <tt>`-L${prefix}/lib -lstdair'</tt>)
+
+
+
\section dynamiclinking Using StdAir with dynamic linking
When using static linking some of the library routines in StdAir are
Modified: trunk/stdair/doc/local/stdair_footer.html
===================================================================
--- trunk/stdair/doc/local/stdair_footer.html 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/stdair_footer.html 2010-08-01 16:17:26 UTC (rev 249)
@@ -1,6 +1,9 @@
<div style="clear: both; width: 100%; height: 31px; background-color: #ffff00; border: 1px solid #b0b0b0; margin: 5px 5px 5px 0; padding: 2px;">
- <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=177703&type=1" alt="SourceForge Logo" style="float: right; border: 0;"></a>
- <p style="padding-left: 10px; font-size: 85%;">Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html">Doxygen</a> $doxygenversion</p>
+ <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=267760&type=1" alt="SourceForge Logo" style="float: right; border: 0;"></a>
+
+ <p style="padding-left: 10px; font-size: 85%;">Generated on $datetime for
+ $projectname by <a href="http://www.doxygen.org/index.html">Doxygen</a> $doxygenversion</p>
+
</div>
</body>
</html>
Modified: trunk/stdair/doc/local/stdair_header.html
===================================================================
--- trunk/stdair/doc/local/stdair_header.html 2010-07-28 13:09:40 UTC (rev 248)
+++ trunk/stdair/doc/local/stdair_header.html 2010-08-01 16:17:26 UTC (rev 249)
@@ -14,6 +14,6 @@
src="stdair_logo.png" alt="StdAir Logo"
style="float: left; border: 0;"></a>
<a href="http://sourceforge.net/projects/stdair/"><img width="150"
- height="40" src="sfx_logo.png" alt="Sourceforge Logo"
+ height="40" src="sfx_logo.png" alt="Get Standard Airline IT Object Library at SourceForge.net. Fast, secure and Free Open Source software downloads"
style="float: right; border: 0;"></a>
</div>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
