Changes between Version 9 and Version 10 of user-directories


Ignore:
Timestamp:
Jul 16, 2007 1:26:30 PM (13 years ago)
Author:
andreasw
Comment:

updated directory structure page

Legend:

Unmodified
Added
Removed
Modified
  • user-directories

    v9 v10  
    2121Coin-Clp --- BuildTools
    2222 |            |--- headers
     23 |            |--- compile_f2c
     24 |            |--- share
    2325 |
    2426 |---------- Data
    2527 |            |--- Netlib
    26  |            ---- Samples
     28 |            |--- Samples
     29 |            |---  ...
    2730 |
    2831 |---------- CoinUtils
     
    3033 |            |--- inc
    3134 |            |--- test
     35 |            |--- MSVisualStudio
     36 |                  |--- v6
     37 |                  |--- v7
     38 |                  ---- v8
    3239 |            |--- [doc]      ([ ] means currently missing)
    3340 |            ---- [examples]
     
    3744 |            |--- inc
    3845 |            |--- test
     46 |            |--- MSVisualStudio
     47 |                  |--- v6
     48 |                  |--- v7
     49 |                  ---- v8
    3950 |            |--- [doc]
    4051 |            ---- examples
    41  |
    42  ----------- MSDevStudio
    4352 |
    4453 ----------- doxydoc
     
    4756In the '''base directory of the package''' ({{{Coin-Clp}}}, or {{{Clp-x.y.z}}}, depending on how you obtained the code and called this directory) 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.
    4857
    49 The '''!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.
     58The '''!BuildTools''' directory contains files and scripts that pertain to the COIN-OR build system; most files here 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.
     59The {{{compile_f2c}}} subdirectory has some scripts and instructions on how to use the {{{f2c}}} Fortran-to-C translator within COIN-OR for the MS Visual C++ compiler.  Finally, the {{{share}}} directory contains a sample {{{config.site}}} file that also explains most of the options for {{{configure}}}.
    5060
    5161Some 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.
    52 
    53 If 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].
    5462
    5563Also, 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}}}.
     
    6573 * '''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.
    6674
     75 * '''MSVisualStudio''': If present, the subdirectories contain project files for the MS Developer Studio.  The {{{v6}}}, {{{v7}}}, and {{{v8}}} subdirectories pertain to versions 6, 7, and 8 of the Developer Studio. For details on this, visit the [http://projects.coin-or.org/MSVisualStudio MSVisualStudio home page].
     76
    6777 * '''doc''': If documetation is provided for this COIN project, it should be found here.
    6878