From 6fd26850532608a81ef2f1a5d1bfb7095b6975ad Mon Sep 17 00:00:00 2001 From: "Janet B. Anderson" Date: Wed, 8 Apr 2009 19:31:53 +0000 Subject: [PATCH] More updates and format changes --- documentation/README.html | 242 +++++++++++++++++++++----------------- 1 file changed, 131 insertions(+), 111 deletions(-) diff --git a/documentation/README.html b/documentation/README.html index e33ca7479..926afab95 100644 --- a/documentation/README.html +++ b/documentation/README.html @@ -2,9 +2,9 @@ README.html -

Installation Instructions

-

EPICS base

-

Release 3.14.*


+
+

Installation Instructions

+

EPICS base Release 3.14.*


Table of Contents

@@ -55,7 +55,7 @@ README.html 
aix-ppc
 aix-ppc-gnu
-cygwin-x86 (unix style API, links with cygwin1.dll)
+cygwin-x86 (unix style API, uses cygwin1.dll compatability library)
 darwin-ppc
 darwin-x86
 darwin-ppcx86
@@ -74,8 +74,8 @@ solaris-sparc64-gnu
 solaris-x86
 solaris-x86-gnu
 win32-x86
-win32-x86-mingw (WIN32 API, links with standard MS dlls)
-win32-x86-cygwin (WIN32 API, links with standard MS dlls)
+win32-x86-mingw (WIN32 API, uses MS dlls)
+win32-x86-cygwin (WIN32 API, uses MS dlls)

Cross compile target platforms (operating system - architecture)

@@ -189,120 +189,126 @@ http://www.aps.anl.gov/epics hosted at APS with a list repeater at BESSY. See the EPICS home page for subscription instructions.

Directory Structure

-
Distribution directory structure:
     +

Distribution directory structure:

+
base                         Root directory of the base distribution -
     base/config                  R3.13 compatibility build +
base/config                  R3.13 compatibility build configuration files -
     base/config/tools            Perl and shell scripts used +
base/config/tools            Perl and shell scripts used in the R3.13 build -
     base/configure               Operating system independent +
base/configure               Operating system independent build config files -
     base/configure/os            Operating system dependent +
base/configure/os            Operating system dependent build config files -
     base/configure/tools         Perl and shell scripts used +
base/configure/tools         Perl and shell scripts used in the build -
     base/documentation           Distributation documentation -
     base/src                     All epics base source code in +
base/documentation           Distributation documentation +
base/src                     All epics base source code in subdirectories -
     base/src/RTEMS               Code to configure RTEMS for +
base/src/RTEMS               Code to configure RTEMS for EPICS -
     base/src/as                  Access security -
     base/src/bpt                 Break point table -
     base/src/ca                  Channel access -
     base/src/cap5                Channel Access client +
base/src/as                  Access security +
base/src/bpt                 Break point table +
base/src/ca                  Channel access +
base/src/cap5                Channel Access client interface for Perl 5 -
     base/src/cas                 Channel access server library +
base/src/cas                 Channel access server library and examples -
     base/src/catools             Channel access tools caget, +
base/src/catools             Channel access tools caget, cainfo, camonitor, caput -
     base/src/db                  Database access -
     base/src/db/test             Database access tests -
     base/src/dbStatic            Static database access -
     base/src/dbtools             Database dbLoadTemplate tools -
     base/src/dev                 Device support (camacDev, +
base/src/db                  Database access +
base/src/db/test             Database access tests +
base/src/dbStatic            Static database access +
base/src/dbtools             Database dbLoadTemplate tools +
base/src/dev                 Device support (camacDev, softDev, and testDev) -
     base/src/excas               Example channel access server -
     base/src/gdd                 General data descriptor -
     base/src/libCom              General purpose library code +
base/src/excas               Example channel access server +
base/src/gdd                 General data descriptor +
base/src/libCom              General purpose library code in subdirectories -
     base/src/libCom/bucketLib    Hash bucket -
     base/src/libCom/calc         Algebraic expression +
base/src/libCom/bucketLib    Hash bucket +
base/src/libCom/calc         Algebraic expression interpreter -
     base/src/libCom/cppStd       Support for C++ standard +
base/src/libCom/cppStd       Support for C++ standard template library -
     base/src/libCom/cvtFast      Fast number to string +
base/src/libCom/cvtFast      Fast number to string conversion -
     base/src/libCom/cxxTemplates C++ templates and templates +
base/src/libCom/cxxTemplates C++ templates and templates tests -
     base/src/libCom/dbmf         Memory management for +
base/src/libCom/dbmf         Memory management for frequent alloc/free -
     base/src/libCom/ellLib       EPICS double linked list -
     base/src/libCom/env          Default EPICS environment +
base/src/libCom/ellLib       EPICS double linked list +
base/src/libCom/env          Default EPICS environment settings -
     base/src/libCom/error        Error handling definitions +
base/src/libCom/error        Error handling definitions and routines -
     base/src/libCom/fdmgr        File descriptor manager -
     base/src/libCom/freeList     Memory management using free +
base/src/libCom/fdmgr        File descriptor manager +
base/src/libCom/freeList     Memory management using free lists -
     base/src/libCom/gpHash       General purpose hash table -
     base/src/libCom/logClient    Logging client -
     base/src/libCom/macLib       Macro substitution handler -
     base/src/libCom/misc         Miscellaneous utilities -
     base/src/libCom/osi          Operating system independent +
base/src/libCom/gpHash       General purpose hash table +
base/src/libCom/logClient    Logging client +
base/src/libCom/macLib       Macro substitution handler +
base/src/libCom/misc         Miscellaneous utilities +
base/src/libCom/osi          Operating system independent code -
     base/src/libCom/osi/os       Operating system dependant +
base/src/libCom/osi/os       Operating system dependant code in subdirectories -
     base/src/libCom/ring         Methods for creating and +
base/src/libCom/ring         Methods for creating and using ring buffers -
     base/src/libCom/taskwd       Task watchdog -
     base/src/libCom/test         Test tools (timer, semBinary, +
base/src/libCom/taskwd       Task watchdog +
base/src/libCom/test         Test tools (timer, semBinary, semMutex,fdmgr, ...) -
     base/src/libCom/timer        Timer -
     base/src/libCom/tsDefs       R3.13 time stamp definitions +
base/src/libCom/timer        Timer +
base/src/libCom/tsDefs       R3.13 time stamp definitions and routines -
     base/src/makeBaseApp         Perl tool+templates to create +
base/src/makeBaseApp         Perl tool+templates to create ioc app dvl tree -
     base/src/makeBaseExt         Perl tool+templates to create +
base/src/makeBaseExt         Perl tool+templates to create extension dvl tree -
     base/src/misc                Miscellaneous (coreRelease, +
base/src/misc                Miscellaneous (coreRelease, iocInit, asSub*) -
     base/src/rec                 Record support -
     base/src/registry            EPICS support function +
base/src/rec                 Record support +
base/src/registry            EPICS support function registry -
     base/src/rsrv                Channel access ioc resource +
base/src/rsrv                Channel access ioc resource server library -
     base/src/softIoc             Example softIoc -
     base/src/tools               Perl scripts used during the +
base/src/softIoc             Example softIoc +
base/src/tools               Perl scripts used during the builds -
     base/src/toolsComm           Code for the build tools +
base/src/toolsComm           Code for the build tools antelope and e_flex -
     base/src/util                Utilities (ca_test, +
base/src/util                Utilities (ca_test, iocLogServer, startCArepeater) -
     base/src/vxWorks             R3.13 compatibility code +
base/src/vxWorks             R3.13 compatibility code specific to vxWorks -
     base/startup                 Scripts for setting up path +
base/startup                 Scripts for setting up path and environment -

     Install directories created by the build:

-

     bin                     Installed scripts and executables in +

+

Install directories created by the build:

+
+

bin                     Installed scripts and executables in subdirs -
     cfg                     Installed build configuration +
cfg                     Installed build configuration files -
     db                      Installed data bases -
     dbd                     Installed data base definitions -
     doc                     Installed documentation files -
     html                    Installed html documentation -
     include                 Installed header files -
     include/os              Installed os specific header files +
db                      Installed data bases +
dbd                     Installed data base definitions +
doc                     Installed documentation files +
html                    Installed html documentation +
include                 Installed header files +
include/os              Installed os specific header files in subdirs -
     javalib                 Installed java class and jar files -
     lib                     Installed libraries in arch +
javalib                 Installed java class and jar files +
lib                     Installed libraries in arch subdirectories -
     lib/perl                Installed perl modules -
     templates               Installed templates

+
lib/perl                Installed perl modules +
templates               Installed templates

+
+

Build related components

-
  • base/documentation/README* files
    • -
    README.1st           Instructions for setup and building epics +

    base/documentation/README* files

    +
    + README.1st           Instructions for setup and building epics base
    README.html          html version of README.1st
    README.WIN32         Microsoft WIN32 specific instructions @@ -314,10 +320,10 @@ http://www.aps.anl.gov/epics

    KnownProblems.html   List of known problems and workarounds
    Converting*To*.html  Release specific conversion instructions
    Building*With*.html  Release specific build instructions -
      -
  • base/startup directory - contains scripts to set environment and - path
    • -
    EpicsHostArch       c shell script to set EPICS_HOST_ARCH env +
    +

    base/startup directory - contains scripts to set environment and path

    +
    + EpicsHostArch       c shell script to set EPICS_HOST_ARCH env variable
    EpicsHostArch.pl    perl script to set EPICS_HOST_ARCH env variable @@ -333,9 +339,10 @@ http://www.aps.anl.gov/epics
    variables
    win32-debug.bat     WIN32 debug bat file to set debug path and env variables -
      -
  • base/configure  directory - contains build definitions and rules
    • -
    CONFIG                Includes configure files and allows + +

    base/configure  directory - contains build definitions and rules

    +
    +CONFIG                Includes configure files and allows variable overrides
    CONFIG.CrossCommon    Cross build definitions
    CONFIG.gnuCommon      Gnu compiler build definitions for all @@ -370,8 +377,10 @@ http://www.aps.anl.gov/epics
    and tar)
    Sample.Makefile       Sample makefile with comments
      -
  • base/configure/os directory - contains os-arch specific definitions
    • -
    CONFIG.<host>.<target>      Specific host-target build + +

    base/configure/os directory - contains os-arch specific definitions

    +
    + CONFIG.<host>.<target>      Specific host-target build definitions
    CONFIG.Common.<target>      Specific target definitions for all hosts @@ -392,15 +401,15 @@ http://www.aps.anl.gov/epics

    CONFIG_SITE.<host>.Common   Site specific host defs for all targets
      -
  • base/configure/tools directory - contains Perl scripts used for the - build
    • -
    convertRelease.pl       Performs consistancy checks on RELEASE + +

    base/src/tools directory - contains Perl scripts used for the build

    +
    + Makefile                Makefile for installing the scripts into cfg dir
    + convertRelease.pl       Performs consistancy checks on RELEASE files -
    cp.pl                   This Perl script copies an existing - file
    cvsclean.pl             Remove all .#* files in directory tree -
    dos2unix.pl             Converts text file from DOS CR/LF to - unix ISO +
    dos2unix.pl             Converts text file from DOS CR/LF to unix ISO +
    expandvars.pl           Tool to expand @VAR@ variables while copying a file
    filterWarnings.pl       Filters warning messages during HP builds
    fullpathName.pl         Returns fullpath name of directory arg @@ -409,16 +418,15 @@ http://www.aps.anl.gov/epics

    makeIncludeDbd.pl       Creates *Include.dbd file from filename args files
    makeMakefile.pl         Creates a Makefile in O.<arch> dirs -
    makeMakefileInclude.pl  Creates file to be included by Makefile -
    mkdir.pl                Creates a directory (like Unix mkdir) +
    makeTestfile.pl         Generates a test harness $target.t file
    mkmf.pl                 Generates dependencies from include stmnts
    munch.pl                Creates a ctdt.c file for vxWorks targets -
    mv.pl                   Renames an existing file. -
    replaceVAR.pl           Changes CapFast VAR(xxx) to $(xxx) - notation -
    rm.pl                   Quietly removes an existing file +
    replaceVAR.pl           Changes CapFast VAR(xxx) to $(xxx) notation +
    useManifestTool.pl      Use MS VC++ version to set usage of Manifest Tool + +

    Building EPICS base (Unix and Win32)

    Unpack file

    @@ -474,26 +482,38 @@ Files in the base/startup directory have been provided to
    Site configuration
    To configure EPICS, you may want to modify the default definitions - in the following files:
    configure/CONFIG_SITE     - Build choices. Specify target archs. configure/CONFIG_SITE_ENV - Environment variable defaults configure/RELEASE          - TORNADO 2 full path location
    Host configuration + in the following files: +
    + configure/CONFIG_SITE       +Build choices. Specify target archs.
     + configure/CONFIG_SITE_ENV   + Environment variable defaults
    + configure/RELEASE           + TORNADO2 full path location +
    Host configuration
    To configure each host system, you may override the default definitions by adding a new file in the configure/os directory with override definitions. The new file should have the same name as the distribution file to be overridden except with CONFIG in the name - changed to CONFIG_SITE.
    -configure/os/CONFIG.<host>.<host>        Host build settings -
    configure/os/CONFIG.<host>.Common        Host common build - settings
    Target configuration + changed to CONFIG_SITE.
    + configure/os/CONFIG.<host>.<host> +     + Host build settings
    + configure/os/CONFIG.<host>.Common +     + Host common build settings +
    Target configuration
    To configure each target system, you may override the default definitions by adding a new file in the configure/os directory with override definitions. The new file should have the same name as the distribution file to be overridden except with CONFIG in the name replaced by CONFIG_SITE. This step is necessary even if the host system - is the only target system.
    -configure/os/CONFIG.Common.<target>   Target common settings -
    configure/os/CONFIG.<host>.<target>  Host-target settings
    + is the only target system.
    + configure/os/CONFIG.Common.<target>   + Target common settings
    + configure/os/CONFIG.<host>.<target>   + Host-target settings +
    R3.13 compatibility configuration
    To configure EPICS base for building with R3.13 extensions and ioc applications , you must modify the default definitions in the