epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Documentation updates for release

Browse Source 
Mostly version numbers, a few text and formatting changes.
This commit is contained in:
Andrew Johnson
2021-02-28 20:04:16 -06:00
parent a9ff175cf0
commit bb7b754730
3 changed files with 53 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
documentation/README.md
View File

@ -1,6 +1,6 @@
# Installation Instructions {#install}
## EPICS Base Release 7.0.4.1
## EPICS Base Release 7.0.5
-----
@ -12,7 +12,6 @@
- [Supported platforms](#0_0_4)
- [Supported compilers](#0_0_5)
- [Software requirements](#0_0_6)
- [Host system storage requirements](#0_0_7)
- [Documentation](#0_0_8)
- [Directory Structure](#0_0_10)
- [Build related components](#0_0_11)
@ -39,7 +38,7 @@ interfaces) of various types.
Please check the `RELEASE_NOTES` file in the distribution for
description of changes and release migration details.
### <span id="0_0_3">Copyright</span>
### <span id="0_0_3">Copyright Licenses</span>
Please review the LICENSE file included in the distribution for legal
terms of usage.
@ -68,10 +67,10 @@ path to do EPICS builds; check the definitions of CC and CCC in
**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.
that a gnumake version 4.1 or later is available.
**Perl**
You must have Perl version 5.8.1 or later installed. The EPICS
You must have Perl version 5.10 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.
@ -114,13 +113,6 @@ 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.
### <span id="0_0_7">Host system storage requirements</span>
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.
### <span id="0_0_8">Documentation</span>
EPICS documentation is available through the [EPICS
@ -242,17 +234,13 @@ Before you can build or use this EPICS base, the environment variable
the base/startup directory has been provided to help set
`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
architecture, e.g. linux-x86_64. 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
Windows). See `configure/CONFIG_SITE` for a list of supported
`EPICS_HOST_ARCH` values.
* `PERLLIB`
On WIN32, some versions of Perl require that the environment
variable PERLLIB be set to &lt;perl directory location>.
* `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

44
documentation/RELEASE_NOTES.md
View File

@ -11,12 +11,7 @@ release.
The PVA submodules each have their own individual sets of release notes which
should also be read to understand what has changed since earlier releases.
**This version of EPICS has not been released yet.**
## Changes made on the 7.0 branch since 7.0.4.1
<!-- Insert new items immediately below here ... -->
## EPICS Release 7.0.5
### Fix aai's Device Support Initialization
@ -301,6 +296,8 @@ GNUmake added the directive `undefine` in version 3.82 to allow variables to
be undefined. Support for this has been added to the EPICS Release file parser,
so `undefine` can now be used in configure/RELEASE files to unset variables.
-----
## EPICS Release 7.0.4.1
### ARM Architecture Changes
@ -348,6 +345,8 @@ Bad character ' ' in record name "bad practice"
if a record name begins with a minus, plus, left square bracket,
or left curly bracket.
-----
## EPICS Release 7.0.4
### Bug fixes
@ -532,6 +531,8 @@ devLsiEtherIP = {
};
```
-----
## EPICS Release 7.0.3.1
**IMPORTANT NOTE:** *Some record types in this release will not be compatible
@ -725,6 +726,8 @@ necessary, all RTEMS targets should now link although the IOC won't be able to
be used with the VME I/O on those systems (that we don't have VMEbus I/O
support for in libCom).
-----
## EPICS Release 7.0.3
### `epicsTimeGetCurrent()` optimization
@ -745,6 +748,8 @@ This may result in slightly fewer, but larger frames being sent.
Report NOBT as "precision" through the dbAccess API. This is not accessible
through CA, but is planned to be used through QSRV.
-----
## EPICS Release 7.0.2.2
### Build System changes
@ -779,6 +784,8 @@ substantial than bug fixes.
Turns out this is ~10x slower to query than `CLOCK_MONOTONIC`.
-----
## EPICS Release 7.0.2.1
### Linking shared libraries on macOS
@ -830,6 +837,8 @@ rewrite of the link address parser code in dbStaticLib. This release fixes that
issue, although in some cases the output may be slightly different than it used
to be.
-----
## EPICS Release 7.0.2
### Launchpad Bugs
@ -847,6 +856,8 @@ modules. The layout of the source files has not changed at all however, so the
source code for libcom, ca and the database are still found separately under
the module subdirectory.
-----
## EPICS Release 7.0.1.1
### Changed SIML failure behavior
@ -905,7 +916,11 @@ than is currently available, but as developers we generally much prefer to
write code than documentation. Send questions to the tech-talk mailing list
and we'll be happy to try and answer them!
## Changes between 3.16.1 and 3.16.2
-----
## Changes made between 3.16.1 and 3.16.2
### Launchpad Bugs
The list of tracked bugs fixed in this release can be found on the
[Launchpad Milestone page for EPICS Base 3.16.2](https://launchpad.net/epics-base/+milestone/3.16.2).
@ -1112,6 +1127,8 @@ array is made even larger; the previous array buffer was not being released
correctly. See Launchpad
[bug #1706703](https://bugs.launchpad.net/epics-base/+bug/1706703).
-----
## Changes made between 3.16.0.1 and 3.16.1
### IOC Database Support for 64-bit integers
@ -1548,6 +1565,7 @@ and then replace `(RECSUPFUN)` with `RECSUPFUN_CAST` when initializing the
rset. Further changes might also be needed, e.g. to adapt `const`-ness of
method parameters.
-----
## Changes made between 3.15.3 and 3.16.0.1
@ -1656,6 +1674,8 @@ header and removed the need for dbScan.c to reach into the internals of its
`CALLBACK` objects.
-----
# Changes incorporated from the 3.15 branch
@ -1667,6 +1687,7 @@ The names of the generated junit xml test output files have been changed
from `<testname>.xml` to `<testname>-results.xml`, to allow better
distinction from other xml files. (I.e., for easy wildcard matching.)
-----
## Changes made between 3.15.7 and 3.15.8
@ -1772,6 +1793,7 @@ don't provide it any more.
If multiple IOCs were started at the same time, by systemd say, they could race
to obtain the Channel Access TCP port number 5064. This issue has been fixed.
-----
## Changes made between 3.15.6 and 3.15.7
@ -1915,6 +1937,8 @@ into the htmls directory. Thanks to Tony Pietryla.
This displays the version numbers of EPICS Base and the CA protocol.
-----
## Changes made between 3.15.5 and 3.15.6
### Unsetting environment variables
@ -2140,6 +2164,8 @@ choice string cannot be parsed, the associated periodic scan thread will no
longer be started by the IOC and a warning message will be displayed at iocInit
time. The `scanppl` command will also flag the faulty menuScan value.
-----
## Changes made between 3.15.4 and 3.15.5
### dbStatic Library Speedup and Cleanup
@ -2271,6 +2297,8 @@ will be installed into the target bin directory, from where it can be copied
into the appropriate systemd location and modified as necessary. Installation
instructions are included as comments in the file.
-----
## Changes made between 3.15.3 and 3.15.4
### New string input device support "getenv"
@ -2376,6 +2404,8 @@ variable to a non-zero value before loading the file, like this:
This was [Launchpad bug
541119](https://bugs.launchpad.net/bugs/541119).
-----
## Changes from the 3.14 branch between 3.15.3 and 3.15.4
### NTP Time Provider adjusts to OS tick rate changes

20
documentation/ReleaseChecklist.html
View File

@ -147,17 +147,17 @@ starting at <a href="#ReleaseApproval">Release Approval</a>.</p>
<td>Tag the module in Git, using these tag conventions:
<ul>
<li>
<tt>R7.0.4.1-pre<i>n</i></tt>
<tt>R7.0.5-pre<i>n</i></tt>
&mdash; pre-release tag
</li>
<li>
<tt>R7.0.4.1-rc<i>n</i></tt>
<tt>R7.0.5-rc<i>n</i></tt>
&mdash; release candidate tag
</li>
</ul>
<blockquote><tt>
cd base-7.0<br />
git tag -m 'ANJ: Tagged for 7.0.4.1-rc1' R7.0.4.1-rc1
git tag -m 'ANJ: Tagged for 7.0.5-rc1' R7.0.5-rc1
</tt></blockquote>
Note that submodules must <em>not</em> be tagged with the version used
for the top-level, they each have their own separate version numbers
@ -171,11 +171,11 @@ starting at <a href="#ReleaseApproval">Release Approval</a>.</p>
files and directories that are only used for continuous integration:
<blockquote><tt>
cd base-7.0<br />
./.tools/make-tar.sh R7.0.4.1-rc1 base-7.0.4.1-rc1.tar.gz base-7.0.4.1-rc1/
./.tools/make-tar.sh R7.0.5-rc1 base-7.0.5-rc1.tar.gz base-7.0.5-rc1/
</tt></blockquote>
Create a GPG signature file of the tarfile as follows:
<blockquote><tt>
gpg --armor --sign --detach-sig base-7.0.4.1-rc1.tar.gz
gpg --armor --sign --detach-sig base-7.0.5-rc1.tar.gz
</tt></blockquote>
</td>
</tr>
@ -298,7 +298,7 @@ starting at <a href="#ReleaseApproval">Release Approval</a>.</p>
<li>Tag the module:
<blockquote><tt>
git tag -m 'ANJ: Tag for EPICS 7.0.4.1' &lt;module-version&gt;
git tag -m 'ANJ: Tag for EPICS 7.0.5' &lt;module-version&gt;
</tt></blockquote>
</li>
@ -355,7 +355,7 @@ starting at <a href="#ReleaseApproval">Release Approval</a>.</p>
<td>Tag the epics-base module in Git:
<blockquote><tt>
cd base-7.0<br />
git tag -m 'ANJ: Tagged for release' R7.0.4.1
git tag -m 'ANJ: Tagged for release' R7.0.5
</tt></blockquote>
<p>Don't push these commits or the new tag to the Launchpad repository
yet.</p>
@ -387,12 +387,12 @@ starting at <a href="#ReleaseApproval">Release Approval</a>.</p>
files and directories that are only used for continuous integration:
<blockquote><tt>
cd base-7.0<br />
./.tools/make-tar.sh R7.0.4.1 ../base-7.0.4.1.tar.gz base-7.0.4.1/
./.tools/make-tar.sh R7.0.5 ../base-7.0.5.tar.gz base-7.0.5/
</tt></blockquote>
Create a GPG signature file of the tarfile as follows:
<blockquote><tt>
cd ..<br />
gpg --armor --sign --detach-sig base-7.0.4.1.tar.gz
gpg --armor --sign --detach-sig base-7.0.5.tar.gz
</tt></blockquote>
</td>
</tr>
@ -457,7 +457,7 @@ starting at <a href="#ReleaseApproval">Release Approval</a>.</p>
<td>Upload the tar file and its <tt>.asc</tt> signature file to the
epics-controls web-server.
<blockquote><tt>
scp base-7.0.4.1.tar.gz base-7.0.4.1.tar.gz.asc epics-controls:download/base<br />
scp base-7.0.5.tar.gz base-7.0.5.tar.gz.asc epics-controls:download/base<br />
</tt></blockquote>
</td>
</tr>