From b8a0792fae7acbd31d6c93d0c79849e310b44bcc Mon Sep 17 00:00:00 2001
From: Andrew Johnson
Date: Fri, 13 Apr 2018 10:47:59 -0500
Subject: [PATCH] Update documentation/README files
---
documentation/README.1st | 28 +++++++++++++---------------
documentation/README.html | 30 +++++++++++++++---------------
2 files changed, 28 insertions(+), 30 deletions(-)
diff --git a/documentation/README.1st b/documentation/README.1st
index 4886bea7c..8166b1434 100644
--- a/documentation/README.1st
+++ b/documentation/README.1st
@@ -67,8 +67,9 @@
Software requirements
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.
+ You must use the GNU version of make for EPICS builds, and we now
+ recommend version 4.1 or later (version 3.82 may work on Linux, but
+ doesn't on Windows).
Perl
You must have Perl version 5.8.1 or later installed. The EPICS
@@ -99,20 +100,17 @@
RTEMS
For RTEMS targets, you need RTEMS core and toolset version 4.9.2 or
- later.
+ 4.10. The newer 4.11 or 5.x releases are not supported yet.
- 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 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 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.
+ Command-line editing libraries
+ GNU readline or other OS-specific libraries can be used by the IOC shell
+ to provide command line editing and history recall. The default setting
+ is different for each OS. On Linux the default is to use READLINE since
+ most distributions include it. On MacOS the default is also READLINE
+ since Apple provides a compatible library, although it isn't GNU. On
+ RTEMS we support GNU readline and Tecla, although the default is to use
+ neither since these have to be added to the RTEMS installation
+ separately. On vxWorks we support the built-in ledLib library.
Host system storage requirements
diff --git a/documentation/README.html b/documentation/README.html
index 868043718..d1e2be299 100644
--- a/documentation/README.html
+++ b/documentation/README.html
@@ -72,8 +72,8 @@
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.
+ You must use the GNU version of make for EPICS builds, and we now recommend
+ version 4.1 or later (version 3.82 may work on Linux, but doesn't on Windows).
Perl
You must have Perl version 5.8.1 or later installed. The EPICS configuration
@@ -103,20 +103,20 @@
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.
+ For RTEMS targets, you need RTEMS core and toolset version 4.9.2 or 4.10. The
+ newer 4.11 or 5.x releases are not supported yet.
+
+Command-line editing libraries
+
+ GNU readline or other OS-specific libraries can be used by the IOC shell to
+ provide command line editing and history recall. The default setting is
+ different for each OS. On Linux the default is to use READLINE since most
+ distributions include it. On MacOS the default is also READLINE since Apple
+ provides a compatible library, although it isn't GNU. On RTEMS we support GNU
+ readline and Tecla, although the default is to use neither since these have to
+ be added to the RTEMS installation separately. On vxWorks we support the
+ built-in ledLib 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 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 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.