Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,20 @@ Author: `Ben Franksen`_ (`HZB`_)
About
-----

CaPutLog is an EPICS support module that provides logging for Channel Access
put operations. The current version works with EPICS 3.14.8.2 and later and
CaPutLog is an EPICS support module that provides logging for Channel Access and PV Access
put operations. Support for PV Access put operations is available starting with EPICS 7.0.7.
The current version works with EPICS 3.15.9 and later and
is almost a complete re-write of the original (3.13 compatible) version that
was written by V. Korobov (DESY). It is based on the generic iocLogClient
that is part of the EPICS libCom. Starting a log server requires exactly the
same steps as for the regular iocLogServer, except that you probably want to
use a different port. On the IOC side there are three routines to be called
from the iocShell. See section `Setup`_ below for details.

This module will send logs of CA puts in a text format to a remote logging
This module will send logs of Channel Access and PV Access puts in a text format to a remote logging
server. Currently it supports two output formats, **Original** and **JSON**.
The JSON format is only supported with `EPICS`_ base versions 7.0.1 and later.

PV Access put operations to IOCs running either the QSRV pvAccess server or QSRV2 from the PVXS module are supported.

Download
--------
Expand All @@ -37,6 +38,8 @@ Compatibility Matrix and Release Notes
+---------+------------------+------------------+
| Version | EPICS Release | Release Notes |
+=========+==================+==================+
| 4.2 | 3.15.9 .. 7.0.x | `R4-2`_ |
+---------+------------------+------------------+
| 4.1 | 3.15.9 .. 7.0.x | `R4-1`_ |
+---------+------------------+------------------+
| 4.0 | 3.14.12 .. 7.0.x | `R4-0`_ |
Expand Down Expand Up @@ -401,6 +404,7 @@ If you have any problems with this module, send me (`Ben Franksen`_) a mail.
.. _HZB: http://www.helmholtz-berlin.de/
.. _EPICS: https://epics.anl.gov/
.. _browse: https://github.com/epics-modules/caPutLog/commits/master
.. _R4-2: releasenotes.rst#r4-2-changes-since-r4-1
.. _R4-1: releasenotes.rst#r4-1-changes-since-r4-0
.. _R4-0: releasenotes.rst#r4-0-changes-since-r3-7
.. _R3-5: releasenotes.rst#r3-5-changes-since-r3-4
Expand Down
18 changes: 18 additions & 0 deletions docs/releasenotes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
Release Notes
=============

R4-2: Changes since R4-1
------------------------

* Improve caPutJsonLog support, including fixes to string comparisons.

* Remove Base 3.14–specific code. As of caPutLog R4.1, Base 3.14 is no longer supported due to the use of epicsAtomic.

* Update GitHub Actions workflow and configuration.

* Prevent certain commands from being called before caPutLog initialization.

* Improve and fix caPutJsonLog tests.

* Increase the maximum hostname length.

* Remove unused variables.


R4-1: Changes since R4-0
------------------------

Expand Down