Source code organization

The ROXANE development source code will eventually be available through a CVS server. Releases will be made on a regular basis. The source code is structured as follows:

• roxane/
  
  This is the source root directory; it constains:

  • various administration files (AUTHORS, COPYING, ...) concerning the master bundle. Each package maintains its own administration files;
  • history files (ChangeLog, NEWS, ...) concerning the master bundle. How each individual package keeps track of its history is not specified;
  • a configure script automatically generated from a configure.ac file by Autoconf. This toplevel configure is invoked at configuration time to configure every included package.
  • a Makefile.in file automatically generated from a Makefile.am file by Automake.
  • various configuration and installation helper files.
  • <package>/ : Every package included in ROXANE has its own subdirectory, suitably named, where its source codes go. How that subdirectory is managed is entirely left to the discretion of the author(s) or maintainer(s) of the the package, modulo the Package Configuration Requirements stated below.

  • doc/: General documentations about ROXANE go here.

Package Configuration Requirements

1. Every package should be configurable and buildable in a directory distinct from the source directory. Notice that that requirement does not prohibit in-source build; it allows building in a separate directory.
2. Every <package>/ subdirectory (as described in the source code organization section) should contain a configure script, the purpose of which is to configure that package. How that configure script is provided (e.g. hand-written or generated) is left at the discretion of authors of the package.

3. Each package's configure script should be prepared to accept the following set of options:

   • –prefix =path
     
     This is the installation root directory. For a package, this will appear as user-specified-prefix /roxane .
   • –target =target-canonical-name
     
     Indicates the target's canonical name in form of CPU-VENDOR-OS triplet. For example, if the target is an Intel 686 PC running a GNU/Linux operating system, then this would be i686-pc-linux-gnu .
   • –srcdir =path
     
     Path to directory where the package's source code may be found.
   • –bindir =path
     
     The directory for installing executables run by users.
   • –includedir =path
     
     The directory for installing header files.
   • –libdir =path
     
     The directory for installing object code libraries.
   • –datadir =path
     
     The directory for installing read-only architecture-independent data.
   • –docdir =path
     
     The directory for installing documentations in non-Info, non-man formats.
   • –infodir =path
     
     The directory for installing documentations in Info format.
   • –mandir =path
     
     The directory for installing documentations in man format.
   • –with- package
     
     –without- package
     
     Enable or disable the availability of a package.
   • –enable- feature
     
     –disable- feature
     
     Enable or disable a feature.
   • – package –includes= directory
     
     – package –libraries= directory
     
     

   Packages should not assume any particular order in which these options be may specified. All packages see the same set of options passed down to them by the toplevel configure script.

4. After configuration, every package should produce a set of Makefile (s) containing the necessary infrastructure for build and installation.

Installation Directory Organization

The ROXANE bundle will be installed under the directory ${prefix}/roxane/ where ${prefix} is the value given to the –prefix option at configuration time. When most (all ?) of the options have default values, the installation directory will be structrured as follows:

• bin/
  
  Scripts or links to executables go here. The actual binaries may be kept in the architecture-dependent directory discussed below. See –libexecdir.
  
  The path to this directory is what was given the package's configure script through the option –bindir.

• doc/
  
  Non-info, non-man pages documentation files go here. Each package allocates a subdirectory uniquely named.
  
  The path to this directory is specified to packages with the –docdir option.

• etc/
  
  Generic \"configuration\" files are put here.

• include/
  
  Packages put their headers file here, under a uniquely named subdirectory. The path to this directory is specified with the option –includedir to packages.

• info/
  
  Info files go here. The path to this directory is specified by the –infodir option.

• lib/
  
  Libraries or object files are put here.

• lib/target-canonical-name/
  
  Architecture-dependent excutables run by other programs are put in this subdirectory named after the target. The name of this subdirectory is the target canonical name, a triplet of the form CPU-VENDOR-OS. This canonical name is the one specified with the –target option.
  
  The path to this subdirectory is specified with –libexecdir.

• man/
  
  Where man pages go.
  
  The path to this directory is specified with the –mandir option.

• share/
  
  Target independent data files may be put here. Specified with the option –datadir .

Toplevel configure options

The toplevel roxane/configure script [not yet? avalaible] understands the following options:

• –prefix=install-path
  
  The argument value install-path is where the ROXANE bundle will be installed. If omitted, it defaults to /usr/local.

• –with-package
  
  –without-package
  
  Includes or excludes the configuration, build and installation of package.

• –enable- feature
  
  –disable- feature