docs: add documentation for the work around, link to release notes
Warning, cannot access the index:
_darcs/index: opening of '_darcs/index' failed: permission denied (Permission denied)
diff -rN -u old-repo/docs/conf.py new-repo/docs/conf.py
--- old-repo/docs/conf.py 2022-09-28 11:27:34.375135354 +0200
+++ new-repo/docs/conf.py 2022-09-28 11:27:34.375135354 +0200
@@ -1,8 +1,5 @@
# -*- coding: utf-8 -*-
#
-# seq documentation build configuration file, created by
-# sphinx-quickstart on Tue May 11 18:36:35 2010.
-#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
@@ -163,4 +160,4 @@
#html_file_suffix = ''
# Output file base name for HTML help builder.
-#htmlhelp_basename = 'seqdoc'
+#htmlhelp_basename = 'fellerdoc'
diff -rN -u old-repo/docs/index.txt new-repo/docs/index.txt
--- old-repo/docs/index.txt 2022-09-28 11:27:34.375135354 +0200
+++ new-repo/docs/index.txt 2022-09-28 11:27:34.375135354 +0200
@@ -8,6 +8,12 @@
:Maintainer: Ben Franksen <benjamin.franksen@helmholtz-berlin.de>
:Bug Reports: tech-talk@aps.anl.gov
+.. toctree::
+ :hidden:
+
+ Home <self>
+ ReleaseNotes
+
Welcome to the home page of the **feller** project.
About
@@ -30,7 +36,9 @@
========= ===========================
Version Release Notes
--------- ---------------------------
- `0.1`_ no release notes yet
+ `0.3`_ :ref:`Release 0.3`
+ `0.2`_ :ref:`Release 0.2`
+ `0.1`_ :ref:`Release 0.1`
========= ===========================
Development snapshots are available under the name
@@ -41,6 +49,8 @@
`latest snapshot`_.
.. _latest snapshot: http://www-csr.bessy.de/control/SoftDist/feller/releases/feller-snapshot-latest.tar.gz
+.. _0.3: http://www-csr.bessy.de/control/SoftDist/feller/releases/feller-0.3.tar.gz
+.. _0.2: http://www-csr.bessy.de/control/SoftDist/feller/releases/feller-0.2.tar.gz
.. _0.1: http://www-csr.bessy.de/control/SoftDist/feller/releases/feller-0.1.tar.gz
Install
@@ -48,14 +58,33 @@
Follow the usual procedure for installing an EPICS support module.
+EPICS base versions 3.14.12.3 and earlier do not have the function
+errlogRemoveSingleListener. If you use such a base version you have two
+possibilities:
+
+1. You can apply ``add_errlogRemoveSingleListener.patch`` to your base
+ and (in feller) uncomment the definition of BASE_HAS_errlogRemoveSingleListener
+ in ``configure/CONFIG_SITE``.
+
+2. You just compile/install feller as is and leave
+ BASE_HAS_errlogRemoveSingleListener undefined. This will cause an
+ implementation to be compiled that works around the missing function
+ by adding only one errlog listener (and never removing it), and which
+ traverses the internal list of fellers itself (rather than letting the
+ errlog facility do it).
+
API
===
-There is one type and 3 functions, and a (convenience) macro. ::
+There is one type and 3 functions, and a (convenience) macro.
+
+::
struct feller;
-The (opaque) type of feller objects. ::
+The (opaque) type of feller objects.
+
+::
struct feller *fellerCreate(const char *filename);
@@ -67,7 +96,7 @@
fellerDestroy(struct feller *this)
Destroy a feller object.
-
+
::
char *fellerGetHeader(struct feller *this)
@@ -87,8 +116,10 @@
want to print the message to the console. You can of course define your own
wrapper macros, maybe calling other errlog print functions.
-Caveat: This requires gcc, since it defines a macro with a variable number of
-arguments.
+.. warning::
+
+ This requires gcc, since it defines a macro with a variable number of
+ arguments.
Usage
patch 7d86a9cfab74e57035e21d56273f7996262e0a5d
Author: benjamin.franksen@helmholtz-berlin.de
Date: Fri Jun 21 14:49:30 CEST 2013
* docs: add documentation for the work around, link to release note