Changes between Version 5 and Version 6 of user-directories


Ignore:
Timestamp:
Jun 2, 2006 11:51:14 AM (14 years ago)
Author:
andreasw
Comment:

cleaned up

Legend:

Unmodified
Added
Removed
Modified
  • user-directories

    v5 v6  
    33== Nomenclature ==
    44
    5 Here and in the other !BuildTools wiki pages we distinguish between a '''COIN packages''' and a '''COIN project''':
     5Here and in the other !BuildTools wiki pages we distinguish between a '''COIN package''' and a '''COIN project''':
    66
    77 * '''Coin Project''':  With this we mean the files grouped together as one project in COIN.  This contains usually the source code to build a library or a program.  However, in order to actually compile and link this code, it might be necessary to have the files from other COIN projects available.
     
    1313== Directory Structure For A COIN Package ==
    1414
    15 The directory structure might differ for individual packages in COIN.  However, we recommend to project managers to follow the layout below.  As example we use the {{{Clp}}} package, which requires the {{{CoinUtils}}} project and some data files (to run the unit test program) as dependencies.  We assume here that the package base directory has been called {{{Coin-Clp}}} by the user.
     15The directory structure might differ for individual packages in COIN.  However, we recommend to project managers to follow the layout below.  As example we use the {{{Clp}}} package, which requires the {{{CoinUtils}}} project and some data files (to run the unit test and example programs) as dependencies.  We assume here that the package base directory has been called {{{Coin-Clp}}} by the user.
    1616
    1717If you download the source code for a package (here {{{Clp}}}), you will find the following structure.
     
    4646In 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.
    4747
    48 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 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.
     48The '''BuildTools''' directory contains files and scripts that are only necessary for project maintainers.  In its subdirectory {{{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.
    4949
    5050Some 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.
     
    5252If 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].
    5353
    54 Also, for packages containing C++ code, you will find a '''doxydoc''' subdirectory.  This contains a configuration script for the {{{doxygen}}} utility, which generates HTML documentation of the source code.  Once you have the package configured, you can create this documentation with {{{make doxydox}}} (assuming that you have {{{doxygen}}} installed.  The final documentation will be in {{{doxydoc/html}}}.
     54Also, for packages containing C++ code, you will find a '''doxydoc''' subdirectory.  This contains a configuration script for the {{{doxygen}}} utility, which generates HTML documentation of the source code.  Once you have the package configured, you can create this documentation with {{{make doxydox}}} (assuming that you have {{{doxygen}}} installed).  The final documentation will be in {{{doxydoc/html}}}.
    5555
    56 For each COIN project that is required to build the desired packages, you will find a '''project subdirectory''' in the base directory.  In the main subdirectory 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.
     56For each COIN project that is required to build the desired packages, you will find a '''project subdirectory''' in the base directory.  In the main subdirectory for each project (above {{{CoinUtils}}} and {{{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 information such as a README and AUTHORS file.
    5757
    5858If the project manager of a COIN project follows our suggest directory structure, you will find the '''following subdirectories in the project's main subdirectory''' (e.g., in {{{Clp}}} or {{{CoinUtils}}} above):
    5959
    60  * '''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.
     60 * '''src''': Here resides the source code for the package, possibly divided into 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.
    6161
    62  * '''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.
     62 * '''inc''': If the project 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.
    6363
    6464 * '''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.
     
    6666 * '''doc''': If documetation is provided for this COIN project, it should be found here.
    6767
    68  * '''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.
     68 * '''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 code to the library.  The source files, an example Makefile, and further information for this can be found here.
    6969
    7070