"Fossies" - the Fresh Open Source Software Archive

Member "SAOImageDS9/tcllib/devdoc/dirlayout_install.txt" (13 Nov 2019, 2958 Bytes) of package /linux/misc/ds9.8.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 Tcllib installation directory layout
    2 ====================================
    3 
    4 This document describes the possible layouts for an installed tcllib,
    5 discusses their pro and contra and makes a choice for Tcllib 1.4. A
    6 roadmap of changes in the future is made available as appendix.
    7 
    8 [L1/D] Deep layout
    9 ------------------
   10 
   11         This is the layout of Tcllib 1.3 (and versions before that).
   12 
   13         A single directory tcllib<version> is created, and all
   14         subdirectories of the 'modules' subdirectory in the
   15         distribution is copied into it. This is restricted at large to
   16         *.tcl files, with exception made for some modules with special
   17         needs.
   18 
   19         Pro:
   20         Contra:
   21                 Makes the handling of the various package indices,
   22                 well, not difficult, but uncomfortable.
   23 
   24 
   25 [L2/Fa] Flat layout 1
   26 ---------------------
   27 
   28         A directory is created for each module of tcllib.
   29 
   30         Pro:
   31                 Handling of package indices is easier than for L1/D, a
   32                 toplevel index file with all its problems is not
   33                 required anymore.
   34 
   35         Contra:
   36                 Directories should be versioned to avoid conflicts
   37                 between multiple releases. modules have no
   38                 version. This can be faked for modules containing one
   39                 package, but not for the modules with more.
   40 
   41 
   42 [L2/Fb] Flat layout 2
   43 ---------------------
   44 
   45         A directory is created for each package in tcllib.
   46 
   47         Pro
   48                 Handling of package indices is easy, one per package.
   49 
   50         Contra:
   51                 Modules containing more than one package are difficult
   52                 to handle. The system has to split them into the
   53                 individual packages. This rendered very difficult
   54                 because of shared package index files.
   55         
   56                 This can be solved by moving tcllib (back) towards of
   57                 one package per module. When that goal is reached
   58                 L2/Fa and L2/Fb become the same, and the contra for
   59                 L2/Fa vanishes too as an exact version number can be
   60                 associated with each directory.
   61 
   62 Chosen layout for Tcllib 1.4
   63 ----------------------------
   64 
   65         L1/D
   66 
   67         Despite the problems with package indices the contras against
   68         the flat structures are too strong at this point in
   69         time. Automatic solutions are not really possible, or require
   70         a very high effort.
   71 
   72 Roadmap
   73 -------
   74         Change the module directories of tcllib to contain exactly one
   75         package per directory, with appropriate index (and meta data).
   76 
   77         This not only makes sense for easier handling of installation
   78         and package indices, but also in the greater context of
   79         wrapping code for deployment.
   80 
   81 
   82 -----------------------------------
   83 This document is in the public domain.
   84 
   85                         Andreas Kupries <andreas_kupries@users.sf.net>