diff --git a/documentation/README.md b/documentation/README.md index 444dd44cc..78df41d55 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -1,8 +1,6 @@ # Installation Instructions -## EPICS Base Release 3.15.6 - - +## EPICS Base Release 7.0.3.1 ----- @@ -38,7 +36,7 @@ interfaces) of various types. ### What is new in this release? -Please check the RELEASE\_NOTES file in the distribution for +Please check the `RELEASE_NOTES` file in the distribution for description of changes and release migration details. ### Copyright @@ -49,7 +47,7 @@ terms of usage. ### Supported platforms The list of platforms supported by this version of EPICS base is given -in the configure/CONFIG\_SITE file. If you are trying to build EPICS +in the `configure/CONFIG_SITE` file. If you are trying to build EPICS Base on an unlisted host or for a different target machine you must have the proper host/target cross compiler and header files, and you will have to create and add the appropriate new configure files to the @@ -64,55 +62,54 @@ vendor's C and C++ compilers, as well as the GNU gcc and g++ compilers. The GNU cross-compilers work for all cross-compiled targets. You may need the C and C++ compilers to be in your search path to do EPICS builds; check the definitions of CC and CCC in -base/configure/os/CONFIG.<host>.<host> if you have problems. +`base/configure/os/CONFIG..` if you have problems. ### Software requirements -**GNU make** +**GNU make** You must use GNU make, gnumake, for any EPICS builds. Set your path so that a gnumake version 3.81 or later is available. -**Perl** +**Perl** You must have Perl version 5.8.1 or later installed. The EPICS configuration files do not specify the perl full pathname, so the perl executable must be found through your normal search path. -**Unzip and tar (Winzip on WIN32 systems)** +**Unzip and tar (Winzip on WIN32 systems)** You must have tools available to unzip and untar the EPICS base distribution file. -**Target systems** +**Target systems** EPICS supports IOCs running on embedded platforms such as VxWorks and RTEMS built using a cross-compiler, and also supports soft IOCs running as processes on the host platform. -**vxWorks** -You must have vxWorks 5.5.x or 6.x installed if any of your target -systems are vxWorks systems; the C++ compiler for vxWorks 5.4 is now -too old to support. The vxWorks installation provides the +**vxWorks** +You must have vxWorks 6.8 or later installed if any of your target +systems are vxWorks systems; the C++ compiler from older versions cannot +compile recently developed code. The vxWorks installation provides the cross-compiler and header files needed to build for these targets. The absolute path to and the version number of the vxWorks installation -must be set in the base/configure/os/CONFIG\_SITE.Common.vxWorksCommon +must be set in the `base/configure/os/CONFIG_SITE.Common.vxWorksCommon` file or in one of its target-specific overrides. -Consult the [vxWorks 5.x](https://epics.anl.gov/base/tornado.php) or -[vxWorks 6.x](https://epics.anl.gov/base/vxWorks6.php) EPICS web pages -about and the vxWorks documentation for information about configuring -your vxWorks operating system for use with EPICS. +Consult the [vxWorks 6.x](https://epics.anl.gov/base/vxWorks6.php) EPICS +web pages about and the vxWorks documentation for information about +configuring your vxWorks operating system for use with EPICS. -**RTEMS** -For RTEMS targets, you need RTEMS core and toolset version 4.9.2 or -later. +**RTEMS** +For RTEMS targets, you need RTEMS core and toolset version 4.9.x or +4.10.x (4.11 or 5.x are not yet supported). -**GNU readline or Tecla library** +**GNU readline or Tecla library** GNU readline and Tecla libraries can be used by the IOC shell to provide command line editing and command line history recall and edit. GNU readline (or Tecla library) must be installed on your target -system when COMMANDLINE\_LIBRARY is set to READLINE (or TECLA) for +system when `COMMANDLINE_LIBRARY` is set to READLINE (or TECLA) for that target. EPICS (EPICS shell) is the default specified in -CONFIG\_COMMON. A READLINE override is defined for linux-x86 in the -EPICS distribution. Comment out COMMANDLINE\_LIBRARY=READLINE in -configure/os/CONFIG\_SITE.Common.linux-x86 if readline is not +`CONFIG_COMMON`. A READLINE override is defined for linux-x86 in the +EPICS distribution. Comment out `COMMANDLINE_LIBRARY=READLINE` in +`configure/os/CONFIG_SITE.Common.linux-x86` if readline is not installed on linux-x86. Command-line editing and history will then be those supplied by the os. On vxWorks the ledLib command-line input library is used instead. @@ -136,7 +133,7 @@ base/documentation directory of the distribution. #### 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 @@ -147,7 +144,7 @@ base/documentation directory of the distribution. #### Install directories created by the build: -``` +``` bin Installed scripts and executables in subdirs cfg Installed build configuration files db Installed data bases @@ -166,7 +163,7 @@ base/documentation directory of the distribution. #### base/documentation directory - contains setup, build, and install documents -``` +``` README.md Instructions for setup and building epics base README.darwin.html Installation notes for Mac OS X (Darwin) RELEASE_NOTES.html Notes on release changes @@ -175,7 +172,7 @@ base/documentation directory of the distribution. #### base/startup directory - contains scripts to set environment and path -``` +``` EpicsHostArch Shell script to set EPICS_HOST_ARCH env variable unix.csh C shell script to set path and env variables unix.sh Bourne shell script to set path and env variables @@ -185,17 +182,17 @@ base/documentation directory of the distribution. #### 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 archs - CONFIG_ADDONS Definitions for <osclass> and DEFAULT options - CONFIG_APP_INCLUDE + 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_FILE_TYPE CONFIG_SITE Site specific make definitions CONFIG_SITE_ENV Site defaults for EPICS environment variables MAKEFILE Installs CONFIG* RULES* creates @@ -206,25 +203,25 @@ base/documentation directory of the distribution. 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_TARGET - RULES_TOP Rules specific to a <top> dir (uninstall and tar) + RULES_EXPAND + RULES_FILE_TYPE + RULES_TARGET + RULES_TOP Rules specific to a dir (uninstall and tar) Sample.Makefile Sample makefile with comments ``` #### 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 - CONFIG.<host>.Common Specific host definitions for all targets +``` + CONFIG.. Specific host-target build definitions + CONFIG.Common. Specific target definitions for all hosts + CONFIG..Common Specific host definitions for all targets CONFIG.UnixCommon.Common Definitions for Unix hosts and all targets CONFIG.Common.UnixCommon Definitions for Unix targets and all hosts CONFIG.Common.vxWorksCommon Specific host definitions for all vx targets - CONFIG_SITE.<host>.<target> Site specific host-target definitions - CONFIG_SITE.Common.<target> Site specific target defs for all hosts - CONFIG_SITE.<host>.Common Site specific host defs for all targets + CONFIG_SITE.. Site specific host-target definitions + CONFIG_SITE.Common. Site specific target defs for all hosts + CONFIG_SITE..Common Site specific host defs for all targets ``` ### Building EPICS base (Unix and Win32) @@ -239,24 +236,24 @@ systems. Files in the base/startup directory have been provided to help set required path and other environment variables. -**EPICS\_HOST\_ARCH** +* `EPICS_HOST_ARCH` Before you can build or use EPICS R3.15, the environment variable -EPICS\_HOST\_ARCH must be defined. A perl script EpicsHostArch.pl in +`EPICS_HOST_ARCH` must be defined. A perl script EpicsHostArch.pl in the base/startup directory has been provided to help set -EPICS\_HOST\_ARCH. You should have EPICS\_HOST\_ARCH set to your +`EPICS_HOST_ARCH.` You should have `EPICS_HOST_ARCH` set to your host operating system followed by a dash and then your host architecture, e.g. solaris-sparc. If you are not using the OS vendor's c/c++ compiler for host builds, you will need another dash followed by the alternate compiler name (e.g. "-gnu" for GNU c/c++ compilers on a solaris host or "-mingw" for MinGW c/c++ compilers on -a WIN32 host). See configure/CONFIG\_SITE for a list of supported -EPICS\_HOST\_ARCH values. +a WIN32 host). See `configure/CONFIG_SITE` for a list of supported +`EPICS_HOST_ARCH` values. -**PERLLIB** +* `PERLLIB` On WIN32, some versions of Perl require that the environment variable PERLLIB be set to <perl directory location>. -**PATH** +* `PATH` As already mentioned, you must have the perl executable and you may need C and C++ compilers in your search path. For building base you also must have echo in your search path. For Unix host builds you @@ -265,52 +262,52 @@ also need ln, cpp, cp, rm, mv, and mkdir in your search path and ranlib in your path, and the C compiler may require as and ld in your path. On solaris systems you need uname in your path. -**LD\_LIBRARY\_PATH** +* `LD_LIBRARY_PATH` R3.15 shared libraries and executables normally contain the full path to any libraries they require. However, if you move the EPICS files or directories from their build-time location then in order -for the shared libraries to be found at runtime LD\_LIBRARY\_PATH +for the shared libraries to be found at runtime `LD_LIBRARY_PATH` must include the full pathname to -$(INSTALL\_LOCATION)/lib/$(EPICS\_HOST\_ARCH) when invoking +`$(INSTALL_LOCATION)/lib/$(EPICS_HOST_ARCH)` when invoking executables, or some equivalent OS-specific mechanism (such as /etc/ld.so.conf on Linux) must be used. Shared libraries are now built by default on all Unix type hosts. #### Do site-specific build configuration -**Site configuration** +**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 TORNADO2 full path location ``` -**Host configuration** +**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. +changed to `CONFIG_SITE`. -``` - configure/os/CONFIG.<host>.<host> Host build settings - configure/os/CONFIG.<host>.Common Host common build settings +``` + configure/os/CONFIG.. Host build settings + configure/os/CONFIG..Common Host common build settings ``` -**Target configuration** +**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 +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 +``` + configure/os/CONFIG.Common. Target common settings + configure/os/CONFIG.. Host-target settings ``` #### Build EPICS base @@ -319,7 +316,7 @@ After configuring the build you should be able to build EPICS base by issuing the following commands in the distribution's root directory (base): -``` +``` gnumake clean uninstall gnumake ``` @@ -353,7 +350,7 @@ the host system. A perl script, makeBaseExt.pl, is included in the distribution file. This script will create a sample extension that can be built and executed. The makeBaseApp.pl and makeBaseExt.pl scripts are installed -into the install location bin/<hostarch> directory during the base +into the install location `bin/` directory during the base build. ### Multiple host platforms @@ -367,7 +364,7 @@ into the `$(INSTALL_LOCATION)/bin/` directories. Libraries are installed into $`(INSTALL_LOCATION)/lib/`. The default definition for `$(INSTALL_LOCATION)` is `$(TOP)` which is the root directory in the distribution directory structure, base. Created -object files are stored in O.<arch> source subdirectories, This +object files are stored in `O.` source subdirectories, This allows objects for multiple cross target architectures to be maintained at the same time. To build EPICS base for a specific host/target combination you must have the proper host/target C/C++ diff --git a/documentation/RELEASE_NOTES.md b/documentation/RELEASE_NOTES.md index dfca1922d..746d954bd 100644 --- a/documentation/RELEASE_NOTES.md +++ b/documentation/RELEASE_NOTES.md @@ -1083,7 +1083,11 @@ Added a new macro `callbackGetPriority(prio, callback)` to the callback.h header and removed the need for dbScan.c to reach into the internals of its `CALLBACK` objects. -## Changes from the 3.15 branch since 3.15.6 +## Changes from the 3.15 branch since 3.15.7 + +> None. + +## Changes made between 3.15.6 and 3.15.7 ### GNU Readline detection on Linux