Subversion Repositories DevTools

Index

    JATS Installation Process

        Host-specific Installation Operation

    Creating the JATS package for Release (Automated Release)

    Creating the JATS package for Release (Manual Release)

    Notes on directory layout

================================================================================

================================================================================

JATS Installation Process

-------------------------

1) Place the JATS package in a suitable directory

2) Perform the host-specific installation operation

        SOLARIS: run the script PostInstall.sh

        WINDOWS: do nothing

3) Tailor the JATS startup script

        SOLARIS: tailor TOOLS/jats.sh

        LINUX:   tailor TOOLS/jats.sh

        WINDOWS: tailor TOOLS/jats.bat

   The JATS startup script may be copied to a directory within the users

   PATH and the various values within the script may be alterred to suite

   the users environment.

   The JATS startup script may be modified in-situ and the users PATH

   extended to include the TOOLS directory.

   The JATS startup script is designed to need no changes from JATS

   release to JATS release. Its sole purpose is to startup another

   JATS script that is contained within the release.

JATS Requirements

-----------------

1) Perl no later than 5.8.8

2) Compilers and tools as required by the targets being built

========================================================================

Host-specific Installation Operation

-----------------------------------

SOLARIS and LINUX (Done by PostInstall.sh)

    1) Make the scripts in TOOLS executable

    2) Make the binaries in BIN.xxx executable as required

    3) Untar the links.tar file in BIN.xxx as required

WINDOWS

    Nothing

========================================================================

========================================================================

Creating the JATS package for Release (Automated Release)

---------------------------------------------------------

1) Create a New automated version in Release Manager

   Use: HOME > TECHNOLOGY GROUP > Build Environment TOOLS

   The package is 'core_devl'

2) Make changes to the JATS files

3) Update the ChangeLog.txt file

   Update the Version

   Update the Release Date.

   Describe changes

4) Label ALL files in the core_devl view with the CORE_DEVL.XXXX.CR.WIP label

   or the label provided by Release Manager.

5) Use Release Manager to Release and build the package

   The Build Demons should build and install the package

   The PostInstall processing will be run

6) On "auperaarc01", locate the released package in core_devl

   Create a symlink from the new version to 'jats_new'

   ie: sudo ln -s 3.10.3000.cr jats2_new

   At 3:00Am Perth Time a cronjob will update jats2_current from jats2_new

7) Inform users via the Google++ group called: JATS Build System

================================================================================

================================================================================

Notes on directory layout

The current directory structure is given by the picture below:

    /.../core_devl/:

      |-BIN.linux_i386/:

      |-BIN.solaris10_sparc32/:

      |-BIN.solaris10_x86/:

      |-BIN.sparc/:

      |-BIN.win32/:

      |-BUILD/:

      |-CFG/:

      |   |-PLATFORM/:

      |   |-SH/:

      |   |-TOOLSET/:

      |-TEMPLATES/:

      |-TEST/:

      |   `-version1/:

      |-TOOLS/:

      |   |-DEPLOY/:

      |   |-LIB/:

      |   |   |-Clearcase/:

      |   |   |-DeployUtils/:

      |   |-LOCAL/:

      |-UTILS/:

Details:

/.../core_devl

    The root of the core_devl view in the ClearCase VOB

    The only files in the directory should be readme's and the build.pl file

BIN.linux_i386

BIN.solaris10_sparc32

BIN.solaris10_x86

BIN.sparc

BIN.win32

    These directories contain machine-specific binaries used by JATS at runtime.

    There is one directory for each machine-type supported by JATS

    The Unix machine directories contain machine-specific binaries and

    a file that will be used to create symbolic links when the package is

    installed.

    The win32 directory contains a great number of Unix-like utilities.

    These are not cygwin.

BUILD

    This directory contains build files used when the package is built.

    Building core_devel is really a process of creating an install image.

    No binaries are compiled by the 'build' process.

CFG

  |-PLATFORM

  |-SH

  |-TOOLSET

  The files in the CFG subdirectory tree are used by JATS in the process of

  creating makefiles.

  CFG/PLATFORM: Contains files for each 'platform' known to JATS

  CFG/TOOLSET:  Contains files for each 'toolset' known to JATS

  CFG/SH:       Unknown. May be complete rubbish and may not be required any

                         more

TEMPLATES

    Example build and makefiles for various aspects of JATS

    There are no build.pl files in the example. They all use the alternate

    file name of build_test.pl

    Could do to be expanded

TEST

    Test builds

    Very under represented

    Would be nice to have a 'test' build that did something simple

    for each platform currently supported. Would provide a nice test of

    the installation of the required compilers.

TOOLS

  |-DEPLOY

  |-LIB

     |-Clearcase

     |-DeployUtils

    The TOOLS directory contains the jats front-end and utilities that can

    be run with the 'jats etool' command.

    The TOOLS/DEPLOY directory contains 'old' deployment utilities that now

    run under JATS. Some useful stuff. Also run with 'jats etool'

    The TOOLS/LIB directory contains (mostly) perl modules that are used

    extensively by JATS.

    TOOLS/LIB/DeployUtils and TOOLS/LIB/Clearcase contain Perl modules used by

    the TOOLS/DEPLOYutilities. Mostly legacy stuff. Still used, but not actively

    maintained.

UTILS

   This directory contains sources for binary utilities used by jats.

   The utilities are (mostly) NOT JATS buildable

   They are built by hand and only need to be built when a new machine

   type is added to JATS.