Changes between Version 2 and Version 3 of user-directories


Ignore:
Timestamp:
May 26, 2006 1:11:38 PM (14 years ago)
Author:
andreasw
Comment:

finished first draft

Legend:

Unmodified
Added
Removed
Modified
  • user-directories

    v2 v3  
    11= Understanding the Directory Structure =
    22
    3 The directory structure might differ for individual projects in COIN.  However, we recommend to project managers to follow the layout below.  The example below uses is the {{{Clp}}} project, which requires the {{{CoinUtils}}} project and some data files (to run the unit test program).  We assume here that the base directory has been called {{{Coin-Clp}}} by the user.
     3The directory structure might differ for individual projects in COIN.  However, we recommend to project managers to follow the layout below.  As example we use the {{{Clp}}} project, which requires the {{{CoinUtils}}} project and some data files (to run the unit test program).  We assume here that the base directory has been called {{{Coin-Clp}}} by the user.
    44
    55If you download the source code for a project (here {{{Clp}}}), you will find the following structure.
     
    2020 |            ---- [examples]
    2121 |
    22  |----------- Clp
    23               |--- src
    24               |--- inc
    25               |--- test
    26               |--- [doc]
    27               ---- examples
     22 |---------- Clp
     23 |            |--- src
     24 |            |--- inc
     25 |            |--- test
     26 |            |--- [doc]
     27 |            ---- examples
     28 |
     29 ----------- MSDevStudio
    2830}}}
    2931
    30 In the case directory of the package ({{{Coin-Clp}}}) resides the main configuration script and Makefile.  A user should only issue commands in this directory.  The scripts and Makefiles automatically recurse into the correct subdirectories.
     32In the base directory of the package ({{{Coin-Clp}}}) resides the main configuration script and Makefile.  A user should only issue commands in this directory.  The scripts and Makefiles automatically recurse into the correct subdirectories.
    3133
    32 The {{{BuildTools}}} directory contains files and scripts that are only necessary for project maintainers.  In its subdirectories {{{headers}} are versions of the configuration header files with system dependent information (such as available of certain system header files).  On a UNIX-like system, where the configuration script automatically generates the configuration header files for the system it is run on, the files in this directory are not used.  However, if one uses other environments to build the COIN binaries (such as the MS Developer Studio), those header files are required.
     34The {{{BuildTools}}} directory contains files and scripts that are only necessary for project maintainers.  In its subdirectories {{{headers}}} are versions of the configuration header files with system dependent information (such as availability of certain system header files).  On a UNIX-like system, where the configuration script automatically generates the configuration header files for the system it is run on, the files in this directory are not used.  However, if one uses other environments to build the COIN binaries (such as the MS Developer Studio), those header files are required.
    3335
    34 Some projects require data files, in order to run the unit test program, or the provided examples.  Those files reside in subdirectories of the {{{Data}}} directory.
     36Some projects require data files, in order to run the unit test program or the provided examples.  Those files reside in subdirectories of the {{{Data}}} directory.
    3537
    36 For each COIN project that is required to build the desired packages, you will find a subdirectory with its name in the {{{Coin-Clp}}} base directory.  In the main directory for each project (e.g., {{{Clp}}}) resides the configuration script for this project, as well as the main Makefile.  However, you should not run those configuration scripts from these subdirectories; use the configuration scripts from the base directory instead.  In the main directory for each project you find also package-specific inforation such as a README and AUTHORS file.
     38If MS Developer Studio workspace and projects files (or similar configuration files) are maintained for the considered package, you will find those in the {{{MSDevStudio}}} subdirectory.  For details on this, visit the [http://projects.coin-or.org/MSDevStudio MSDevStudio home page].
     39
     40For each COIN project that is required to build the desired packages, you will find a subdirectory in the {{{Coin-Clp}}} base directory.  In the main directory for each project (e.g., {{{Clp}}}) resides the configuration script for this project, as well as the main Makefile.  However, you should not run those configuration scripts from these subdirectories; use the configuration scripts from the base directory instead.  In the main directory for each project you find also package-specific inforation such as a README and AUTHORS file.
    3741
    3842If the project manager of a COIN project follows our suggest directory structure, you will find the following subdirectories in the project's main directory (e.g., in {{{Clp}}} or {{{CoinUtils}}} above):
    3943
    40  * {{{src}}}: Here resides the source code for the package, possible distributed in further subdirectories, together with the Makefile (which is automatically called from the Makefiles below).  Note, if you are a user for a COIN library, you should not include the header files from this directories, but instead "install" the package properly and get the headers from the installed {{include}} directory.
     44 * {{{src}}}: Here resides the source code for the package, possibly divided in further subdirectories, together with the Makefile to compile the code (which is automatically called from the main Makefile).  Note, if you are a user for a COIN library, you should not include the header files from this directory, but instead "install" the package properly and get the headers from the installed {{{include}}} directory.
    4145
    42  * {{{inc}}}: If the system is using a configuration header file (which is automatically generated when you run the configuration script), it is put here.  Again, if you are a user for a COIN library, do not include this file from here, but from the installed {{{include}}} directory.
     46 * {{{inc}}}: If the project is using a configuration header file that is automatically generated when you run the configuration script, it is put here.  Again, if you are a user for a COIN library, do not include this file from here, but from the installed {{{include}}} directory.
    4347
    4448 * {{{test}}}: We ask project maintainers to provide some test program(s) to be able to verify a successful compilation, so that a user can test that everything is working fine, before (s)he installs the libraries and other files.  The code and possibly some data files for this unit test are located here.
    4549
    46  * {{{doc}}}: If documetation s provided for this COIN project, it should be found here.
     50 * {{{doc}}}: If documetation is provided for this COIN project, it should be found here.
    4751
    4852 * {{{examples}}}: A package might contain some source code examples, for example to demonstrate how a user of a library can hook up his/her own down to the library.  The source files and further information for this can be found here.
    4953
    5054
    51 After you compiled the code successfully, you can "install" the package (and automatically all it's dependencies), using {{{make install}}} (see '''????''').  By default, the files are install in the
     55After you compiled the code successfully on a UNIX-type system, you can "install" the package (and automatically all its dependencies), using {{{make install}}} (see '''????''').  By default, the files are installed in newly created subdirectories {{{bin}}}, {{{lib}}}, and {{{include}}} in the package's base directory ({{{Coin-Clp}}} above).  If you want to install the files at a different location (such as {{{/usr/local}}}), you need to specify the {{{--prefix}}} configure script option.