Changes between Version 25 and Version 26 of user-configure


Ignore:
Timestamp:
Oct 6, 2006 1:23:08 PM (13 years ago)
Author:
andreasw
Comment:

updated according to new release policy

Legend:

Unmodified
Added
Removed
Modified
  • user-configure

    v25 v26  
    88
    99Assume that you have dowloaded the package {{{Pkg}}}
    10 in the directory {{{Coin-Pkg}}}.
     10in the directory {{{Coin-Pkg}}}. (If you got the code via a tarball, this directory might have a name like {{{Pgk-x.y.z}}}, where {{{x.y.z}}} is the point release number.)
    1111
    1212Before you can compile the source code using {{{make}}}, the Makefiles have to be created, so that they contain the correct compiler names and options, as well as other system dependent information.  To this purpose, the {{{configure}}} shell scripts in the package's base directory (e.g., {{{Coin-Clp}}}) and in the projects' main directories (such as {{{Coin-Clp/Clp}}}) perform a number of tests and create the final Makefiles.  In addition, a {{{configure}}} script usually creates a header file (such as {{{Coin-Clp/Clp/inc/config_clp.h}}}) for the individual project, which contains {{{#define}}}s to help the source code to adapt to different platforms.
    1313
    14 To run the configuration scripts, you go into the '''base directory''' of the downloaded COIN package (e.g., {{{Coin-Pkg}}}), and type
     14You can run the configuration scipts in the directories where the source files are.  However, we recommend to perform a "VPATH configuration" (see also below), which compiles the code in a separate directory tree:
    1515
     16First you create a new directory for the compiled code, change into this directory and then run the configuration script '''from the base directory''' in it.  The new directory can be anywhere; the following instruction assume that you are in the package's base directory ({{{Coin-Pkg}}}):
    1617{{{
    17 ./configure
     18mkdir build
     19cd build
     20../configure
    1821}}}
    1922
    20 '''Note:''' You should always run the base directory {{{configure}}} script, not those in a project subdirectory (such as {{{Coin-Clp/Clp}}}); the latter usually doesn't work.
     23'''Note:''' You must run the base directory {{{configure}}} script, not one in a project subdirectory (such as {{{Coin-Clp/Clp}}}); the latter doesn't work.
    2124
    2225This picks default settings for compilers and compiler options.  You can change some aspects of the configuration by providing arguments to the configuration script, as described below.
    2326
    24 If the configuration is successful, the {{{configure}}} script usually prints a message indicating this.  '''If the configuration fails''', the output on the screen, or the more detailed output in the {{{config.log}}} in the same directory might help to find the cause.  If you look at the {{{config.log}}} file, you should go to the bottom of this file and page up, until you see the error message; at the end of the file {{{configure}}} still outputs the results of the tests, even in case of failure.
    25 
    26 '''We recommend that you use the VPATH configuration (as described at the bottom of this page).'''  In this way, if something goes wrong and you want to start over, you can just delete everything in that VPATH directory, without possibly deleting any of the original source code.
    27 
    28 If you are not able to fix the problem and want to contact the maintainers, you should submit a bug ticket at the corresponding Trac page and attach the {{{config.log}}} file.
     27If the configuration is successful, the {{{configure}}} script usually prints a message indicating this.  '''If the configuration fails''', the output on the screen, or the more detailed output in one of the {{{config.log}}} files might help to find the cause - see the [wiki:user-troubleshooting Troubleshooting page].  If you are not able to fix the problem and want to contact the maintainers, you should submit a bug ticket at the corresponding Trac page and attach the {{{config.log}}} file that has the detailed error message in it.
    2928
    3029'''Note:'''  If you rerun {{{configure}}} after a successful configuration run, you should do a '''make distclean''' if you changed the options for {{{configure}}}; see also the {{{make}}} target description at the [wiki:user-compile Compiling and installing the package] page.
     
    7372 For the include string:
    7473
    75     {{{--with-cplex-incdir}}}=/usr/ilog/cplex90/include/ilcplex
     74    {{{--with-cplex-incdir}}}="/usr/ilog/cplex90/include/ilcplex"
    7675
    7776 assuming that the header file cplex.h is located in the directory
     
    8382    {{{
    8483./configure --with-cplex-lib="-L/usr/ilog/cplex90/lib/static_pic -lcplex" \
    85             --with-cplex-incdir=usr/ilog/cplex90/include/ilcplex \
     84            --with-cplex-incdir="/usr/ilog/cplex90/include/ilcplex" \
    8685            --enable-static -C
    8786}}}
     
    136135''Note: Since the {{{config.site}}} file is a shell script, you must not have any whitespace before and after the "{{{=}}}" symbol in a variable assignment!''
    137136
    138 An '''example [https://projects.coin-or.org/BuildTools/browser/trunk/share/config.site config.site] file''' can be found in the {{{BuildTools/share}}} directory.
     137An '''example [https://projects.coin-or.org/BuildTools/browser/stable/0.5/share/config.site?format=raw config.site] file''' can be found in the {{{BuildTools/share}}} directory.
    139138
    140139== Performing a VPATH Compilation ==
    141140
    142 If you follow the above instructions, the compiled files will be in the same directories as the source files.  It is possible to '''compile the code in a different place than where the source code is''' (using the make VPATH feature).  This can, for example, be handy, if you want to have several compiled versions around (e.g., for different operating systems when you are working on a shared files system, or a production and debug version).
     141It is possible to '''compile the code in a different place than where the source code is''' (using the make VPATH feature).  This can, for example, be handy, if you want to have several compiled versions around (e.g., for different operating systems when you are working on a shared files system, or a production and debug version).
    143142
    144143To do a VPATH compilation, you simply run the {{{configure}}} script in the directory where you want to have the compiled files.  E.g., if the base directory of the COIN packages is in {{{$HOME/Coin-Pkg}}} and you want to compile the code in {{{$HOME/Obj/debug/Coin-Pkg}}}, you type