From eb9d002f035a771b2717f26c8ee1cae71a2e6b84 Mon Sep 17 00:00:00 2001 From: Andrew Johnson Date: Tue, 31 Jul 2012 16:14:27 -0500 Subject: [PATCH] Edit README files, set version numbers. --- documentation/KnownProblems.html | 13 ++-- documentation/README.1st | 103 ++++++------------------------- documentation/README.html | 103 ++++++------------------------- documentation/RELEASE_NOTES.html | 6 +- 4 files changed, 47 insertions(+), 178 deletions(-) diff --git a/documentation/KnownProblems.html b/documentation/KnownProblems.html index 1f730dc1d..f817f37cd 100644 --- a/documentation/KnownProblems.html +++ b/documentation/KnownProblems.html @@ -4,25 +4,26 @@ - Known Problems in R3.15.0 + Known Problems in R3.15.0.1 -

EPICS Base R3.15.0: Known Problems

+

EPICS Base R3.15.0.1: Known Problems

Any patch files linked below should be applied at the root of the -base-3.15.0 tree. Download them, then use the GNU Patch program as +base-3.15.0.1 tree. Download them, then use the GNU Patch program as follows:

-
% cd /path/to/base-3.15.0
+
% cd /path/to/base-3.15.0.1
 % patch -p0 < /path/to/file.patch

 
 
The following significant problems have been reported with this
 version of EPICS Base:

 
 
    
-
-  
  • None yet.
    • 
+  
  • 64-bit Windows builds may not work with some tool-sets, the code in
+    src/legacy/gdd is not comptible with the LLP64 model that Windows
+    uses for its 64-bit ABI.
    • 
 
 

 
diff --git a/documentation/README.1st b/documentation/README.1st
index 1accb0ab5..fbf0c1c96 100644
--- a/documentation/README.1st
+++ b/documentation/README.1st
@@ -1,6 +1,6 @@
                            Installation Instructions
 
-                           EPICS Base Release 3.15.*
+                          EPICS Base Release 3.15.0.1
 
    --------------------------------------------------------------------------
 
@@ -117,10 +117,10 @@
 
   Host system storage requirements
 
-     The GNU zipped tar file is approximately 1.5 MB in size. The unzipped
-     untarred distribution source tree is approximately 9.0 MB. The build
-     created files for each host take approximately 37 MB and the build
-     created files for each cross target take approximately 15 MB.
+     The compressed tar file is approximately 1.6 MB in size. The
+     distribution source tree takes up approximately 12 MB. Each host target
+     will need around 40 MB for build files, and each cross-compiled target
+     around 20 MB.
 
   Documentation
 
@@ -133,59 +133,12 @@
 
     Distribution directory structure:
 
-         base                         Root directory of the base distribution
-         base/configure               Operating system independent build config files
-         base/configure/os            Operating system dependent build config files
-         base/documentation           Distributation documentation
-         base/src                     All epics base source code in subdirectories
-         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 interface for Perl 5
-         base/src/cas                 Channel access server library and examples
-         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, softDev, and testDev)
-         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 interpreter
-         base/src/libCom/cppStd       Support for C++ standard template library
-         base/src/libCom/cvtFast      Fast number to string conversion
-         base/src/libCom/cxxTemplates C++ templates and templates tests
-         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 settings
-         base/src/libCom/error        Error handling definitions and routines
-         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 API
-         base/src/libCom/osi/os       Operating system dependant code in subdirectories
-         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, semMutex,fdmgr, ...)
-         base/src/libCom/timer        Timer
-         base/src/libCom/tsDefs       R3.13 time stamp definitions and routines
-         base/src/makeBaseApp         Perl tool+templates to create ioc app dvl tree
-         base/src/makeBaseExt         Perl tool+templates to create extension dvl tree
-         base/src/misc                Miscellaneous (coreRelease, iocInit, asSub*)
-         base/src/rec                 Record support
-         base/src/registry            EPICS support function registry
-         base/src/rsrv                Channel access ioc resource server library
-         base/src/softIoc             Example softIoc
-         base/src/tools               Perl scripts used during the builds
-         base/src/toolsComm           Code for the build tools antelope and e_flex
-         base/src/util                Utilities (ca_test, iocLogServer, startCArepeater)
-         base/startup                 Scripts for setting up path and environment
+         base                    Root directory of the base distribution
+         base/configure          Operating system independent build config files
+         base/configure/os       Operating system dependent build config files
+         base/documentation      Distributation documentation
+         base/src                Source code in various subdirectories
+         base/startup            Scripts for setting up path and environment
 
     Install directories created by the build:
 
@@ -197,7 +150,7 @@
          html                    Installed html documentation
          include                 Installed header files
          include/os              Installed os specific header files in subdirs
-         javalib                 Installed java class and jar files
+         include/compiler        Installed compiler-specific header files
          lib                     Installed libraries in arch subdirectories
          lib/perl                Installed perl modules
          templates               Installed templates
@@ -208,14 +161,9 @@
 
          README.1st           Instructions for setup and building epics base
          README.html          html version of README.1st
-         README.WIN32         Microsoft WIN32 specific instructions
-         README.cxxTemplates  Information about C++ templates in EPICS base
-         README.niCpu030      NI cpu030 specific instructions
-         README.darwin        Installation notes for Mac OS X (Darwin)
+         README.darwin.html   Installation notes for Mac OS X (Darwin)
          RELEASE_NOTES.html   Notes on release changes
          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
 
@@ -223,10 +171,8 @@
          EpicsHostArch.pl    Perl script to set EPICS_HOST_ARCH env variable
          Site.profile        bourne shell script to set path and env variables
          Site.cshrc          c shell script to set path and env variables
-         borland.bat         WIN32 bat file to set borland path and env variables
          cygwin.bat          WIN32 bat file to set cygwin path and env variables
          win32.bat           WIN32 bat file to set path and env variables
-         win32-debug.bat     WIN32 debug bat file to set debug path and env variables
 
     base/configure directory - contains build definitions and rules
 
@@ -234,14 +180,15 @@
          CONFIG.CrossCommon    Cross build definitions
          CONFIG.gnuCommon      Gnu compiler build definitions for all archs
          CONFIG_ADDONS         Definitions for  and DEFAULT options
+         CONFIG_APP_INCLUDE
          CONFIG_BASE           EPICS base tool and location definitions
          CONFIG_BASE_VERSION   Definitions for EPICS base version number
          CONFIG_COMMON         Definitions common to all builds
          CONFIG_ENV            Definitions of EPICS environment variables
+         CONFIG_FILE_TYPE
          CONFIG_SITE           Site specific make defintions
          CONFIG_SITE_ENV       Site defaults for EPICS environment variables
          MAKEFILE              Installs CONFIG* RULES* creates
-         CONFIG_APP_INCLUDE
          RELEASE               Location of external products
          RULES                 Includes appropriate rules file
          RULES.Db              Rules for database and database definition files
@@ -249,7 +196,10 @@
          RULES_ARCHS           Definitions and rules for building architectures
          RULES_BUILD           Build and install rules and definitions
          RULES_DIRS            Definitions and rules for building subdirectories
+         RULES_EXPAND
+         RULES_FILE_TYPE
          RULES_JAVA            Definitions and rules for java jars and classes
+         RULES_TARGET
          RULES_TOP             Rules specific to a  dir (uninstall and tar)
          Sample.Makefile       Sample makefile with comments
 
@@ -265,23 +215,6 @@
          CONFIG_SITE.Common. Site specific target defs for all hosts
          CONFIG_SITE..Common   Site specific host defs for all targets
 
-    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
-         cvsclean.pl             Remove all .#* files in directory tree
-         dos2unix.pl             Converts text file from DOS CR/LF to unix ISO
-         expandvars.pl           Tool to expand @VAR@ variables while copying a file
-         fullpathName.pl         Returns fullpath name of directory arg
-         installEpics.pl         Installs built files into install directories
-         makeIncludeDbd.pl       Creates *Include.dbd file from filename args files
-         makeMakefile.pl         Creates a Makefile in O. dirs
-         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
-         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
diff --git a/documentation/README.html b/documentation/README.html
index 1c5fea6d2..17b359c1d 100644
--- a/documentation/README.html
+++ b/documentation/README.html
@@ -9,7 +9,7 @@
 
 

 
Installation Instructions

-
EPICS Base Release 3.15.*


+
EPICS Base Release 3.15.0.1


 

 

 
 Table of Contents

@@ -122,10 +122,11 @@

Host system storage requirements

-
The GNU zipped tar file is approximately 1.5 MB in size. The - unzipped untarred distribution source tree is approximately 9.0 MB. The - build created files for each host take approximately 37 MB and the - build created files for each cross target take approximately 15 MB.
+ +
The compressed tar file is approximately 1.6 MB in size. The + distribution source tree takes up approximately 12 MB. Each host target will + need around 40 MB for build files, and each cross-compiled target around 20 + MB.

Documentation

EPICS documentation is available through the @@ -137,59 +138,12 @@

Distribution directory structure:

-        base                         Root directory of the base distribution
-        base/configure               Operating system independent build config files
-        base/configure/os            Operating system dependent build config files
-        base/documentation           Distributation documentation
-        base/src                     All epics base source code in subdirectories
-        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 interface for Perl 5
-        base/src/cas                 Channel access server library and examples
-        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, softDev, and testDev)
-        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 interpreter
-        base/src/libCom/cppStd       Support for C++ standard template library
-        base/src/libCom/cvtFast      Fast number to string conversion
-        base/src/libCom/cxxTemplates C++ templates and templates tests
-        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 settings
-        base/src/libCom/error        Error handling definitions and routines
-        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 API
-        base/src/libCom/osi/os       Operating system dependant code in subdirectories
-        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, semMutex,fdmgr, ...)
-        base/src/libCom/timer        Timer
-        base/src/libCom/tsDefs       R3.13 time stamp definitions and routines
-        base/src/makeBaseApp         Perl tool+templates to create ioc app dvl tree
-        base/src/makeBaseExt         Perl tool+templates to create extension dvl tree
-        base/src/misc                Miscellaneous (coreRelease, iocInit, asSub*)
-        base/src/rec                 Record support
-        base/src/registry            EPICS support function registry
-        base/src/rsrv                Channel access ioc resource server library
-        base/src/softIoc             Example softIoc
-        base/src/tools               Perl scripts used during the builds
-        base/src/toolsComm           Code for the build tools antelope and e_flex
-        base/src/util                Utilities (ca_test, iocLogServer, startCArepeater)
-        base/startup                 Scripts for setting up path and environment
+        base                    Root directory of the base distribution
+        base/configure          Operating system independent build config files
+        base/configure/os       Operating system dependent build config files
+        base/documentation      Distributation documentation
+        base/src                Source code in various subdirectories
+        base/startup            Scripts for setting up path and environment

Install directories created by the build:

@@ -202,7 +156,7 @@ html Installed html documentation include Installed header files include/os Installed os specific header files in subdirs - javalib Installed java class and jar files + include/compiler Installed compiler-specific header files lib Installed libraries in arch subdirectories lib/perl Installed perl modules templates Installed templates @@ -216,14 +170,9 @@ 
         README.1st           Instructions for setup and building epics base
         README.html          html version of README.1st
-        README.WIN32         Microsoft WIN32 specific instructions
-        README.cxxTemplates  Information about C++ templates in EPICS base
-        README.niCpu030      NI cpu030 specific instructions
-        README.darwin        Installation notes for Mac OS X (Darwin)
+        README.darwin.html   Installation notes for Mac OS X (Darwin)
         RELEASE_NOTES.html   Notes on release changes
         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

@@ -234,7 +183,6 @@ Site.cshrc c shell script to set path and env variables cygwin.bat WIN32 bat file to set cygwin path and env variables win32.bat WIN32 bat file to set path and env variables - win32-debug.bat WIN32 debug bat file to set debug path and env variables

base/configure directory - contains build definitions and rules

@@ -243,14 +191,15 @@ CONFIG.CrossCommon Cross build definitions CONFIG.gnuCommon Gnu compiler build definitions for all archs CONFIG_ADDONS Definitions for <osclass> and DEFAULT options + CONFIG_APP_INCLUDE CONFIG_BASE EPICS base tool and location definitions CONFIG_BASE_VERSION Definitions for EPICS base version number CONFIG_COMMON Definitions common to all builds CONFIG_ENV Definitions of EPICS environment variables + CONFIG_FILE_TYPE CONFIG_SITE Site specific make defintions CONFIG_SITE_ENV Site defaults for EPICS environment variables MAKEFILE Installs CONFIG* RULES* creates - CONFIG_APP_INCLUDE RELEASE Location of external products RULES Includes appropriate rules file RULES.Db Rules for database and database definition files @@ -258,7 +207,10 @@ RULES_ARCHS Definitions and rules for building architectures RULES_BUILD Build and install rules and definitions RULES_DIRS Definitions and rules for building subdirectories + RULES_EXPAND + RULES_FILE_TYPE RULES_JAVA Definitions and rules for java jars and classes + RULES_TARGET RULES_TOP Rules specific to a <top> dir (uninstall and tar) Sample.Makefile Sample makefile with comments @@ -276,23 +228,6 @@ CONFIG_SITE.<host>.Common Site specific host defs for all targets -

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
-        cvsclean.pl             Remove all .#* files in directory tree
-        dos2unix.pl             Converts text file from DOS CR/LF to unix ISO
-        expandvars.pl           Tool to expand @VAR@ variables while copying a file
-        fullpathName.pl         Returns fullpath name of directory arg
-        installEpics.pl         Installs built files into install directories
-        makeIncludeDbd.pl       Creates *Include.dbd file from filename args files
-        makeMakefile.pl         Creates a Makefile in O.<arch> dirs
-        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
-        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)

diff --git a/documentation/RELEASE_NOTES.html b/documentation/RELEASE_NOTES.html index 86dc9d80b..499d8ba66 100644 --- a/documentation/RELEASE_NOTES.html +++ b/documentation/RELEASE_NOTES.html @@ -3,16 +3,16 @@ - EPICS Base R3.15.0.x Release Notes + EPICS Base R3.15.0.1 Release Notes -

EPICS Base Release 3.15.0.x

+

EPICS Base Release 3.15.0.1

EPICS Base 3.15.0.x releases are not intended for use in production systems.

-

Changes between 3.14.x and 3.15.0.x

+

Changes between 3.14.x and 3.15.0.1

Cross-builds targeting win32-x86-mingw