Changes between Version 5 and Version 6 of pm-project-config


Ignore:
Timestamp:
Jun 2, 2006 9:06:51 PM (14 years ago)
Author:
andreasw
Comment:

cleaned up

Legend:

Unmodified
Added
Removed
Modified
  • pm-project-config

    v5 v6  
    4848 * '''AC_COIN_PROJECTDIR_INIT''' is a COIN specific macro that inializes a few things and should be included at this place
    4949
    50  * The macro '''AC_COIN_DEBUG_COMPILE''' makes the {{{--enable-debug}}} flag available for {{{configure}}}.  It also sets the Automake conditional accordingly, as well as the {{{COIN_DEBUG}}} for the configuration header file.
     50 * The macro '''AC_COIN_DEBUG_COMPILE''' makes the {{{--enable-debug}}} flag available for {{{configure}}}.  It also sets the Automake conditional {{{COIN_DEUBG}}} accordingly, as well as the {{{COIN_DEBUG}}} for the configuration header file.
    5151
    5252 * The macros '''AC_COIN_PROG_CC''' and '''AC_COIN_PROG_CXX''' determine the name of the C and C++ compiler, and chooses the default compiler options.  One only needs to specify those compilers that are required to compile the source code in the project. If the source code contains Fortran files, one should use '''AC_COIN_PROG_F77'''.
     
    7979If the project is found, a {{{#define}}} will set in the configuration header files with the name {{{COIN_HAS_PRJCT}}} (where {{{PRJCT}}} is replaced by the name of the project in all capital letters, e.g., {{{COIN_HAS_CLP}}} in the example above).  Also, an Automake conditional with the same name will be set to true.
    8080
    81 The project can be listed in any order.
     81The projects can be listed in any order.
    8282
    8383== Checks For Third-Party Components ==
     
    8989 * '''AC_COIN_CHECK_GNU_READLINE''': Check for the readline library.
    9090
    91 Those macros check for the availability of those packages (if required by the user).  If the package is available, it adds the flags required for linking to the {{{ADDLIBS}}} output variable, {{{#define}}}s the preprocessor {{{COIN_HAS_ZLIB}}} (and similar) in the configuration header file, and defines an Automake conditional with the same name.
     91Those macros check for the availability of those packages (if requested by the user with the {{{--enable-gnu-packages}}}).  If the package is available, it adds the flags required for linking to the {{{ADDLIBS}}} output variable, {{{#define}}}s the preprocessor {{{COIN_HAS_ZLIB}}} (and similar) in the configuration header file, and defines an Automake conditional with the same name.
    9292
    9393We also provide a generic macro for testing the availability of other third-party libraries, called '''AC_COIN_HAS_USER_LIBRARY'''.
     
    101101
    102102 1. ''Name of the library package''.  This is the name as it will appear in the {{{configure}}} output.
    103  1. ''Abbreviation of the library package''.  This should all be in capital letters.  Using this macro will make {{{configure}}} options available to the user, to specify the link commands for the library, and the specify the directory in which the library header files can be found.  The name of the flags use the abbreviation given as this second argument to the macro.  In the above exmaple, the {{{--with-cpx-lib}}} flag should be used by the user to specify the link commands, and the flags {{{--with-cpx-incdir}}} to specify the directory with the header files.
    104  1. ''Name of a header file''.  This is the name of a header file that should be in the include directory provided by the user via {{{-with-cpx-incdir}}}.  If this file is not found, the {{{configure}}} script terminates with an error message.  If this argument is omitted, the test will not be performed.
     103 1. ''Abbreviation of the library package''.  This should all be in capital letters.  Using this macro will make {{{configure}}} options available to the user, to specify the link commands for the library, and to specify the directory in which the library header files can be found.  The name of the flags use the abbreviation given as this second argument to the macro.  In the above exmaple, the {{{--with-cpx-lib}}} flag can be used by the user to specify the link commands, and the flags {{{--with-cpx-incdir}}} to specify the directory with the header files.
     104 1. ''Name of a header file''.  This is the name of a header file that should be present in the include directory provided by the user via {{{-with-cpx-incdir}}}.  If this file is not found, the {{{configure}}} script terminates with an error message.  If this argument is omitted, the test will not be performed.
    105105 1. ''Name of a C function in the library''.  This should be the name of a C function has should be defined in the library.  If the users uses the {{{--with-cpx-lib}}} flag, it is tested if this function is indeed available.  If not, the {{{configure}}} script with fail with an error message.  If this argument for the macro is omitted, this test is skipped.
    106106
    107 A user will have to either specify both {{{--with-libname-incdir}}} and {{{--with-libname-lib}}} flags, or none.  After successful completation of the tests, the link commands will be added to the automake output variable {{{ADDLIBS}}}.  Also, the preprocessor macro {{{COIN_HAS_CPX}}} (where CPX is replaced by the abbreviation given to the macro) for the configuration header file and an Automake conditional with the same name are defined.
     107A user will have to either specify both {{{--with-libname-incdir}}} and {{{--with-libname-lib}}} flags, or none.  After successful completation of the tests, the link commands will be added to the automake output variable {{{ADDLIBS}}}.  Also, the preprocessor macro {{{COIN_HAS_CPX}}} (where "CPX" is replaced by the abbreviation given to the macro) for the configuration header file and an Automake conditional with the same name are defined.
    108108
    109109== Generation of Links for Data Files ==
    110110
    111 Some unit test programs and example programs required input data files.  In a VPATH configuration (i.e., the compilation takes place in different directories from where the source files are) it is then important to make sure that links to those data files exist so that the program can be run in those directories.
     111Some unit test programs and example programs require input data files.  In a VPATH configuration (i.e., the compilation takes place in different directories from where the source files are) it is then important to make sure that links to those data files exist so that the programs can be run in those directories.
    112112
    113113To this purpose, the '''AC_COIN_VPATH_LINK''' macro should be used for each such file.  An example of this section of the {{{configure.ac}}} file from the Volume project is
     
    131131If you need to perform other tests, you might need to use further autoconf macros and/or write some {{{/bin/sh}}} code.  For this, please consult the [http://www.gnu.org/software/autoconf/manual/autoconf-2.59/ autoconf documentation].
    132132
    133 If you have questions or run into problems, you can send a message to the COIN !BuildUtils mailing list (which has not yet been created...)
     133If you have questions or run into problems, or would like some help to write a specific test, please submit a ticket at the !BuildTools Trac pages, using the "New Ticket" link above.