Merge lp:~jlmuir/epics-appdev/typo-fixes-3.14 into lp:~epics-documenters/epics-appdev/3.16

[J. Lewis Muir]

Typo fix.

[Ralph Lange (ralph-lange)]

Could you fix the conflict and re-propose?

review: Needs Fixing

[lp:~jlmuir/epics-appdev/typo-fixes-3.14]

38. By Andrew Johnson on 2012-01-06

Merged Lewis' typo fix.

=== modified file 'tex/errorLogging.tex'
--- tex/errorLogging.tex	2011-10-28 20:44:28 +0000
+++ tex/errorLogging.tex	2012-01-06 20:56:29 +0000
@@ -3,26 +3,25 @@
 
 \section{Overview }
 
-Errors detected by an IOC can be divided into classes: Errors related to a particular client and errors not attributable to a 
-particular client. An example of the first type of error is an illegal Channel Access request. For this type of error, a status 
-value should be passed back to the client. An example of the second type of error is a device driver detecting a hardware 
-error. This type of error should be reported to a system wide error handler.
+Errors detected by an IOC can be divided into classes:
+Errors related to a particular client and errors not attributable to a particular client.
+An example of the first type of error is an illegal Channel Access request.
+For this type of error, a status value should be passed back to the client.
+An example of the second type of error is a device driver detecting a hardware error.
+This type of error should be reported to a system wide error handler.
 
 Dividing errors into these two classes is complicated by a number of factors.
 
 \begin{itemize}
-\item In many cases it is not possible for the routine detecting an error to decide which type of error occurred. 
-
-\item Normally, only the routine detecting the error knows how to generate a fully descriptive error message. Thus, if a 
-routine decides that the error belongs to a particular client and merely returns an error status value, the ability to 
-generate a fully descriptive error message is lost. 
-
-\item If a routine always generates fully descriptive error messages then a particular client could cause error message 
-storms.
-
-\item While developing a new application the programmer normally prefers fully descriptive error messages. For a 
-production system, however, the system wide error handler should not normally receive error messages cause by a 
-particular client.
+\item In many cases it is not possible for the routine detecting an error to decide which type of error occurred.
+
+\item Normally, only the routine detecting the error knows how to generate a fully descriptive error message.
+Thus, if a routine decides that the error belongs to a particular client and merely returns an error status value, the ability to generate a fully descriptive error message is lost.
+
+\item If a routine always generates fully descriptive error messages then a particular client could cause error message storms.
+
+\item While developing a new application the programmer normally prefers fully descriptive error messages.
+For a production system, however, the system wide error handler should not normally receive error messages cause by a particular client.
 
 \end{itemize}
 
@@ -37,18 +36,20 @@
 
 \item errlogThread - A thread that passes the messages to all registered listeners.
 
-\item console output and message buffer size - Messages can also be written to the console. The storage for the message 
-queue can be specified by the user.
+\item console output and message buffer size - Messages can also be written to the console.
+The storage for the message queue can be specified by the user.
 
 \item status codes - EPICS status codes.
 
-\item iocLog- A system wide error logger supplied with base. It writes all messages to a system wide file.
+\item iocLog- A system wide error logger supplied with base.
+It writes all messages to a system wide file.
 
 NOTE: Many sites use CMLOG instead of iocLog.
 
 \end{itemize}
 
-NOTE: \verb|recGbl| error routines are also provided. They in turn call one of the error message routines.
+NOTE: \verb|recGbl| error routines are also provided.
+They in turn call one of the error message routines.
 
 \section{Error Message Routines}
 
@@ -64,10 +65,8 @@
 \index{errlogVprintf}
 \index{errlogMessage}
 \index{errlogFlush}
- \verb|errlogPrintf| and  \verb|errlogVprintf| are like \verb|printf| and \verb|vprintf| provided by the standard C library, except 
-that their output is sent to the errlog task; unless configured not to, the output will appear on the console as well. Consult 
-any book that describes the standard C library such as ``The C Programming Language ANSI C Edition" by Kernighan 
-and Ritchie.
+\verb|errlogPrintf| and  \verb|errlogVprintf| are like \verb|printf| and \verb|vprintf| provided by the standard C library, except that their output is sent to the errlog task; unless configured not to, the output will appear on the console as well.
+Consult any book that describes the standard C library such as ``The C Programming Language ANSI C Edition" by Kernighan and Ritchie.
 
 \verb|errlogMessage| sends message to the errlog task.
 
@@ -101,14 +100,14 @@
 \index{errlogGetSevEnumString}
 \index{errlogSetSevToLog}
 \index{errlogGetSevToLog}
-\verb|errlogSevPrintf| and \verb|errlogSevVprintf| are like \verb|errlogPrintf| and  \verb|errlogVprintf| except that they 
-add the severity to the beginning of the message in the form ``sevr=\textless{}value\textgreater{}" where value is one of ``info, minor, major, 
-fatal". Also the message is suppressed if  severity is less than the current severity to suppress. If epicsThreadIsOkToBlock 
-is true, which is true during iocInit, errlogSevVprintf does NOT send output to the errlog task.
-
-\verb|errlogGetSevEnumString| gets the string value of severity. 
-
- \verb|errlogSetSevToLog| sets the severity to log. \verb|errlogGetSevToLog| gets the current severity to log.
+\verb|errlogSevPrintf| and \verb|errlogSevVprintf| are like \verb|errlogPrintf| and  \verb|errlogVprintf| except that they add the severity to the beginning of the message in the form ``sevr=\textless{}value\textgreater{}" where value is one of ``info, minor, major, fatal".
+Also the message is suppressed if  severity is less than the current severity to suppress.
+If \verb|epicsThreadIsOkToBlock| is true, which is true during iocInit, errlogSevVprintf does NOT send output to the errlog task.
+
+\verb|errlogGetSevEnumString| gets the string value of severity.
+
+\verb|errlogSetSevToLog| sets the severity to log.
+\verb|errlogGetSevToLog| gets the current severity to log.
 
 \subsection{Status Routines }
 
@@ -131,25 +130,23 @@
 Where status is defined as:
 
 \begin{itemize}
-\item 0:  Find latest vxWorks or Unix error.
-
-\item -1:  Don't report status.
-
-\item Other:  See ``Return Status Values" above.
+\item 0: Find latest vxWorks or Unix error.
+
+\item -1: Don't report status.
+
+\item Other: See ``Return Status Values" above.
 
 \end{itemize}
 
-\verb|errMessage|, via a call to \verb|errPrintf|, prints the message, the status symbol and string values, and the name of the task 
-which invoked \verb|errMessage|. It also prints the name of the source file and the line number from which the call was 
-issued.
-
-The calling routine is expected to pass a descriptive message to this routine. Many subsystems provide routines built on 
-top of \verb|errMessage| which generate descriptive messages. 
-
-An IOC global variable \verb|errVerbose|, defined as an \verb|external| in \verb|errMdef.h|, specifies verbose messages. If 
-\verb|errVerbose| is \verb|TRUE| then \verb|errMessage| should be called whenever an error is detected even if it is known that the 
-error belongs to a specific client. If \verb|errVerbose| is \verb|FALSE| then \verb|errMessage| should be called only for errors that are 
-not caused by a specific client.
+\verb|errMessage|, via a call to \verb|errPrintf|, prints the message, the status symbol and string values, and the name of the task which invoked \verb|errMessage|.
+It also prints the name of the source file and the line number from which the call was issued.
+
+The calling routine is expected to pass a descriptive message to this routine.
+Many subsystems provide routines built on top of \verb|errMessage| which generate descriptive messages.
+
+An IOC global variable \verb|errVerbose|, defined as an \verb|external| in \verb|errMdef.h|, specifies verbose messages.
+If \verb|errVerbose| is \verb|TRUE| then \verb|errMessage| should be called whenever an error is detected even if it is known that the error belongs to a specific client.
+If \verb|errVerbose| is \verb|FALSE| then \verb|errMessage| should be called only for errors that are not caused by a specific client.
 
 Routine \verb|errPrintf| is normally called as follows:
 
@@ -161,28 +158,28 @@
 Where status is defined as:
 
 \begin{itemize}
-\item 0:  Find latest vxWorks or Unix error.
-
-\item -1:  Don't report status.
-
-\item Other:  See ``Return Status Values", above.
+\item 0: Find latest vxWorks or Unix error.
+
+\item -1: Don't report status.
+
+\item Other: See ``Return Status Values", above.
 
 \end{itemize}
 
 FILE and LINE are defined as:
 
 \begin{itemize}
-\item \_\_FILE\_\_   As shown or \verb|NULL| if the file name and line number should not be printed.
+\item \_\_FILE\_\_  As shown or \verb|NULL| if the file name and line number should not be printed.
 
 \item \_\_LINE\_\_  As shown
 
 \end{itemize}
 
-The remaining arguments are just like the arguments to the C \verb|printf| routine. \verb|errVerbose| determines if the filename 
-and line number are shown.
+The remaining arguments are just like the arguments to the C \verb|printf| routine.
+\verb|errVerbose| determines if the filename and line number are shown.
 
-An EPICS status code can also be converted to a string. If the supplied status code isn't registered in the status code 
-database then the raw status code number is converted into a string in the destination buffer.
+An EPICS status code can also be converted to a string.
+If the supplied status code isn't registered in the status code database then the raw status code number is converted into a string in the destination buffer.
 
 \begin{verbatim}
 #include "errMdef.h"
@@ -198,12 +195,14 @@
 
 \index{epicsPrintf}
 \index{epicsVprintf}
-These are macros that call errlogPrintf and errlogVprintf. They are provided for compatibility.
+These are macros that call errlogPrintf and errlogVprintf.
+They are provided for compatibility.
 
 \section{errlog Listeners}
 
 \index{errlog Listeners}
-Any code can receive errlog message. The following are the calls to add and remove a listener.
+Any code can receive errlog message.
+The following are the calls to add and remove a listener.
 
 \begin{verbatim}
 typedef void(*errlogListener) (void *pvt,const char *message);
@@ -214,34 +213,39 @@
 \index{errlogListener}
 \index{errlogAddListener}
 \index{errlogRemoveListener}
-These routines add/remove a callback that receives each error message. These routines are the interface to the actual 
-system wide error handlers.
+These routines add/remove a callback that receives each error message.
+These routines are the interface to the actual system wide error handlers.
 
 \section{errlogThread}
 
 \index{errlogThread}
-The error message routines can be called by any non-interrupt level code. These routines pass the message to the errlog 
-Thread. If any of the error message routines are called at interrupt level,  \verb|epicsInterruptContextMessage| is 
-called with the message ``errlogPrintf called from interrupt level".
-
-errlogThread manages the messages. Messages are placed in a message queue, which is read by errlogThread. The 
-message queue uses a fixed block of memory to hold all messages. When the message queue is full additional messages 
-are rejected but a count of missed messages is kept. The next time the message queue empties an extra message about the 
-missed messages is generated.
-
-The maximum message size is by default 256  characters. If a message is longer, the message is truncated and a message 
-explaining that it was truncated is appended. There is a chance that long messages corrupt memory. This  only happens if 
-client code is defective. Long messages most likely result from ``\%s" formats with a bad string argument.
+The error message routines can be called by any non-interrupt level code.
+These routines pass the message to the errlog Thread.
+If any of the error message routines are called at interrupt level, \verb|epicsInterruptContextMessage| is called with the message ``errlogPrintf called from interrupt level".
+
+\verb|errlogThread| manages the messages.
+Messages are placed in a message queue, which is read by errlogThread.
+The message queue uses a fixed block of memory to hold all messages.
+When the message queue is full additional messages are rejected but a count of missed messages is kept.
+The next time the message queue empties an extra message about the missed messages is generated.
+
+The maximum message size is by default 256 characters.
+If a message is longer, the message is truncated and a message explaining that it was truncated is appended.
+There is a chance that long messages corrupt memory.
+This only happens if client code is defective.
+Long messages most likely result from ``\%s" formats with a bad string argument.
 
 errlogThread passes each message to any registered listener.
 
 \section{console output and message queue size}
 
-The errlog system can also display messages on the ioc console. It calls \verb|epicsThreadIsOkToBlock| to decide when 
-to display the message. If it is OK to block, the message is displayed by the same thread that calls one of the errlog print 
-routines. If it is not OK to block, errlorThread displays the messages.
+The errlog system can also display messages on the ioc console.
+It calls \verb|epicsThreadIsOkToBlock| to decide when to display the message.
+If it is OK to block, the message is displayed by the same thread that calls one of the errlog print routines.
+If it is not OK to block, errlogThread displays the messages.
 
-Normally the errlog system displays all messages on the console. \verb|eltc| can be used to suppress these messages.
+Normally the errlog system displays all messages on the console.
+\verb|eltc| can be used to suppress these messages.
 
 \begin{verbatim}
 int eltc(int yesno); /* error log to console (0 or 1) */
@@ -252,11 +256,11 @@
 \index{eltc}
 \index{errlogInit}
 \index{errlogInit2}
-eltc determines if errlog task writes message to the console. During error messages storms  this  command can be used to 
-suppress console messages. A argument of 0 suppresses the messages and any other value lets the message go to the 
-console. 
+eltc determines if errlog task writes message to the console.
+During error message storms this command can be used to suppress console messages.
+A argument of 0 suppresses the messages, any other value lets messages go to the console.
 
-errlogInit or errlogInit2 can be used to initialize the error logging system with a larger buffer and maximum message size. 
+\verb|errlogInit| or \verb|errlogInit2| can be used to initialize the error logging system with a larger buffer and maximum message size.
 The default buffer size is 1280 bytes, and the default maximum message size is 256.
 
 \section{Status Codes}
@@ -265,34 +269,34 @@
 EPICS defined status values provide the following features:
 
 \begin{itemize}
-\item Whenever possible, IOC routines return a status value: (0, non-0) means (\verb|OK|, \verb|ERROR|).
+\item Whenever possible, IOC routines return a status value:
+0 means OK, non-0 means an error.
 
-\item The include files for each IOC subsystem contain macros defining error status symbols and strings.
+\item The header files for most IOC subsystems contain macros defining error status symbols and strings.
 
 \item Routines are provided for run time access of the error status symbols and strings.
 
+\index{errVerbose}
 \item A global variable \verb|errVerbose| helps code decide if error messages should be generated.
 
 \end{itemize}
 
-WARNING: During the fall of 1995 a series of tech-talk messages were generated concerning EPICS status values. No 
-consensus was reached.
-
-Whenever it makes sense, IOC routines return a status value encoded similar to the vxWorks error status encoding. The 
-most significant short word indicates the subsystem module within which the error occurred. The low order short word is 
-a subsystem status value. In order that status values do not conflict with the vxWorks error status values all subsystem 
-numbers are greater than 500. 
-
-A file \verb|epics/share/epicsH/errMdef.h| defines each subsystem number. For example the \verb|define| for the 
-database access routines is:
+IOC routines often return a long integer status value, encoded similar to the vxWorks error status encoding.
+On some modern architectures a long integer is more than 32 bits wide, but in order to keep the API compatible the status values are still passed as long integers, even though only 32 bits are ever used.
+The most significant 16 bits indicate the subsystem or module where the error occurred.
+The least significant 16 bits contain a subsystem-specific status value.
+In order that status values do not conflict with the vxWorks error status values, all subsystem numbers are greater than 500.
+
+\index{errMdef.h}
+A header file \verb|errMdef.h| defines macros for all the subsystem numbers.
+For example the database access routines use this module number:
 
 \begin{verbatim}
-#define M_dbAccess  (501 << 16)   \
-/*Database Access Routines*/
+#define M_dbAccess  (501 << 16)   /*Database Access Routines*/
 \end{verbatim}
 
-Directory ``\verb|epics/share/epicsH|" contains an \verb|include| library for every IOC subsystem that returns standard status 
-values. The status values are encoded with lines of the following format: 
+There are header files for every IOC subsystem that returns standard status values.
+The status values are encoded with lines of the following format:
 
 \begin{verbatim}
 #define S_xxxxxxx value /*string value*/
@@ -301,8 +305,7 @@
 For example:
 
 \begin{verbatim}
-#define S_dbAccessBadDBR (M_dbAccess|3) \
-/*Invalid Database Request*/
+#define S_dbAccessBadDBR (M_dbAccess|3) /*Invalid Database Request*/
 \end{verbatim}
 
 For example, when \verb|dbGetField| detects a bad database request type, it executes the statement:
@@ -314,53 +317,58 @@
 The calling routine checks the return status as follows:
 
 \begin{verbatim}
-status = dbGetField( ...);
+status = dbGetField(...);
 if(status) {/* Call was not successful */ }
 \end{verbatim}
 
 \section{iocLog}
 
 \index{iocLog}
-NOTE: Many sites use CMLOG instead of iocLog. See the CMLOG documentation for details.
+NOTE: Many sites use CMLOG instead of iocLog.
+See the CMLOG documentation for details.
 
-This consists of two modules: iocLogServer and iocLogClient. The client code runs on each ioc and listens for the 
-messages generated locally by the errlog system. It also reports the messages from the vxWorks logMsg facility.
+This consists of two modules:
+iocLogServer and iocLogClient.
+The client code runs on each ioc and listens for the messages generated locally by the errlog system.
+It also reports the messages from the vxWorks logMsg facility.
 
 \subsection{iocLogServer}
 
 \index{iocLogServer}
+<<<<<<< TREE
 This runs on a host. It receives messages for all enabled iocLogClients in the local area network. The messages are written 
 to a file. Epics base provides a startup file ``base/src/libCom/log/rc2.logServer", which is a SystemV init script to start the server. 
+=======
+This runs on a host.
+It receives messages for all enabled iocLogClients in the local area network.
+The messages are written to a file.
+Epics base provides a startup file ``base/src/util/rc2.logServer", which is a SystemV init script to start the server.
+>>>>>>> MERGE-SOURCE
 Consult this script for details.
 
-To start a log server on a UNIX or PC workstation you must first set the following environment variables and then run the 
-executable ``iocLogServer" on your PC or UNIX workstation. 
+To start a log server on a UNIX or PC workstation you must first set the following environment variables and then run the executable ``iocLogServer" on your PC or UNIX workstation.
 
 \begin{description}
 
-\item \index{EPICS\_IOC\_LOG\_FILE\_NAME}EPICS\_IOC\_LOG\_FILE\_NAME 
+\item \index{EPICS\_IOC\_LOG\_FILE\_NAME}EPICS\_IOC\_LOG\_FILE\_NAME
 
 The name and path to the log file.
 
 \item \index{EPICS\_IOC\_LOG\_FILE\_LIMIT}EPICS\_IOC\_LOG\_FILE\_LIMIT
 
-The maximum size in characters for the log file (after which it becomes a circular file and writes new 
-messages over old  messages at the beginning of the file). If the value is zero then there is no limit on the 
-size of the log file. 
+The maximum size in characters for the log file (after which it becomes a circular file and writes new messages over old messages at the beginning of the file).
+If the value is zero then there is no limit on the size of the log file.
 
 \item \index{EPICS\_IOC\_LOG\_FILE\_COMMAND}EPICS\_IOC\_LOG\_FILE\_COMMAND
 
-A shell command string used to obtain the log file path name during initialization and in response to 
-SIGHUP. The new path name will replace any path name supplied in EPICS\_IOC\_LOG\_FILE\_NAME.
-
-Thus, if EPICS\_IOC\_LOG\_FILE\_NAME is 
-
-"a/b/c.log" and EPICS\_IOC\_LOG\_FILE\_COMMAND returns ``A/B" or ``A/B/" the log server will be stored 
-at ``A/B/c.log"
-
-If EPICS\_IOC\_LOG\_FILE\_COMMAND is empty then this behavior is disabled. This feature is used at 
-some sites for switching the server to a new directory at a fixed time each day. This variable is currently 
-used only by the UNIX version of the log server.
+A shell command string used to obtain the log file path name during initialization and in response to SIGHUP.
+The new path name will replace any path name supplied in EPICS\_IOC\_LOG\_FILE\_NAME.
+
+Thus, if EPICS\_IOC\_LOG\_FILE\_NAME is ``a/b/c.log" and EPICS\_IOC\_LOG\_FILE\_COMMAND returns ``A/B" or ``A/B/" the log server will be stored at ``A/B/c.log"
+
+If EPICS\_IOC\_LOG\_FILE\_COMMAND is empty then this behavior is disabled.
+This feature is used at some sites for switching the server to a new directory at a fixed time each day.
+This variable is currently used only by the UNIX version of the log server.
 
 \item \index{EPICS\_IOC\_LOG\_PORT}EPICS\_IOC\_LOG\_PORT
 
@@ -368,37 +376,37 @@
 
 \end{description}
 
-To configure an IOC so that its messages are placed in the log you must set the environment variable 
-EPICS\_IOC\_LOG\_INET to the IP address of the host that is running the log server, and EPICS\_IOC\_LOG\_PORT to the 
-TCP/IP port used by the log server.
+To configure an IOC so that its messages are placed in the log you must set the environment variable EPICS\_IOC\_LOG\_INET to the IP address of the host that is running the log server, and EPICS\_IOC\_LOG\_PORT to the TCP/IP port used by the log server.
 
-Defaults for all of the above parameters are specified in  the files \$(EPICS\_BASE)/config/CONFIG\_SITE\_ENV and 
-\$(EPICS\_BASE)/config/CONFIG\_ENV.
+Defaults for all of the above parameters are specified in  the files \$(EPICS\_BASE)/config/CONFIG\_SITE\_ENV and \$(EPICS\_BASE)/config/CONFIG\_ENV.
 
 \subsection{iocLogClient}
 \label{iocLogClient}
 
 \index{iocLogClient}
-This runs on each ioc. It is started by calling:
+This runs on each ioc.
+It is started by calling:
 
 \begin{verbatim}
 iocLogInit();
 \end{verbatim}
 
-The global variable \verb|iocLogDisable| can be used to enable/disable the messages from being sent to the server. Setting 
-this variable to (0,1) (enables,disables) the messages generation. If \verb|iocLogDisable| is set to 1 before calling 
-\verb|iocLogInit| then \verb|iocLogClient| will not even initialize itself. \verb|iocLogDisable| can also be changed to turn 
-logging on or off.
+The global variable \verb|iocLogDisable| can be used to enable/disable the messages from being sent to the server.
+Setting this variable to (0,1) (enables, disables) the messages generation.
+If \verb|iocLogDisable| is set to 1 before calling \verb|iocLogInit| then \verb|iocLogClient| will not even initialize itself.
+\verb|iocLogDisable| can also be changed to turn logging on or off.
 
 \verb|iocLogClient| calls \verb|errlogAddListener| and sends each message to the \verb|iocLogServer|.
 
 \subsection{Configuring a Private Log Server}
 
-In a testing environment it is desirable to use a private log server. This can be done as follows:
+In a testing environment it is desirable to use a private log server.
+This can be done as follows:
 
 \begin{itemize}
 
-\item Add a epicsEnvSet command to your IOC startup file. For example
+\item Add a epicsEnvSet command to your IOC startup file.
+For example
 
 \begin{verbatim}
 ld < iocCore
 
=== modified file 'tex/libCom.tex'
--- tex/libCom.tex	2010-11-15 18:16:16 +0000
+++ tex/libCom.tex	2012-01-06 20:56:29 +0000
@@ -1561,7 +1561,7 @@
 program's main() routine.
 
 On vxWorks and RTEMS, an alternative test harness can be used to run a series of tests in order and summarize the results 
-from them all at the end just like the Perl harness does. The routine testHarness() is called once a the beginning of the test 
+from them all at the end just like the Perl harness does. The routine testHarness() is called once at the beginning of the test 
 harness program. Each test program is run by passing its main routine name to the runTest() macro which expands into a 
 call to the runTestFunc() routine. The last test program or the harness program itself must finish by calling epicsExit() 
 which triggers the test summary mechanism to generate its result outputs (from an epicsAtExit callback routine).
 
=== modified file 'tex/recordSupport.tex'
--- tex/recordSupport.tex	2010-11-15 18:16:16 +0000
+++ tex/recordSupport.tex	2012-01-06 20:56:29 +0000
@@ -3,35 +3,37 @@
 
 \section{Overview}
 
-The purpose of this chapter is to describe record support in sufficient detail such that a C programmer can write new 
-record support modules. Before attempting to write new support modules, you should carefully study a few of the existing 
-support modules. If an existing support module is similar to the desired module most of the work will already be done.
-
-From previous chapters, it should be clear that many things happen as a result of record processing. The details of what 
-happens are dependent on the record type. In order to allow new record types and new device types without impacting the 
-core IOC system, the concept of record support and device support has been created. For each record type, a record 
-support module exists. It is responsible for all record specific details. In order to allow a record support module to be 
-independent of device specific details, the concept of device support has been created.
-
-A record support module consists of a standard set of routines which are called by database access routines. These 
-routines implement record specific code. Each record type can define a standard set of device support routines specific to 
-that record type.
-
-By far the most important record support routine is \verb|process|, which \verb|dbProcess| calls when it wants to process a record. 
-This routine is responsible for the details of record processing. In many cases it calls a device support I/O routine. The 
-next section gives an overview of what must be done in order to process a record. Next is a description of the entry tables 
-that must be provided by record and device support modules. The remaining sections give example record and device 
-support modules and describe some global routines useful to record support modules.
-
-The record and device support modules are the only modules that are allowed to include the record specific include files 
-as defined in \verb|base/rec|. Thus they are the only routines that access record specific fields without going through database 
-access.
+The purpose of this chapter is to describe record support in sufficient detail such that a C programmer can write new record support modules.
+Before attempting to write new support modules, you should carefully study a few of the existing support modules.
+If an existing support module is similar to the desired module most of the work will already be done.
+
+From previous chapters, it should be clear that many things happen as a result of record processing.
+The details of what happens are dependent on the record type.
+In order to allow new record types and new device types without impacting the core IOC system, the concept of record support and device support is used.
+For each record type, a record support module exists.
+It is responsible for all record specific details.
+In order to allow a record support module to be independent of device specific details, the concept of device support has been created.
+
+A record support module consists of a standard set of routines which are called by database access routines.
+These routines implement record specific code.
+Each record type can define a standard set of device support routines specific to that record type.
+
+By far the most important record support routine is \verb|process|, which \verb|dbProcess| calls when it wants to process a record.
+This routine is responsible for the details of record processing.
+In many cases it calls a device support I/O routine.
+The next section gives an overview of what must be done in order to process a record.
+Next is a description of the entry tables that must be provided by record and device support modules.
+The remaining sections give example record and device support modules and describe some global routines useful to record support modules.
+
+The record and its device support modules are the only source files that should include the record specific header files.
+Thus they will be the only routines that access record specific fields without going through database access.
 
 \section{Overview of Record Processing}
 
 \index{Overview of Record Processing}
-The most important record support routine is \verb|process|. This routine determines what record processing means. Before 
-the record specific ``\verb|process|" routine is called, the following has already been done:
+The most important record support routine is \verb|process|.
+This routine determines what record processing means.
+Before the record specific ``\verb|process|" routine is called, the following has already been done:
 
 \begin{itemize}
 \item Decision to process a record.
@@ -57,11 +59,12 @@
 
 \end{itemize}
 
-A complication of record processing is that some devices are intrinsically asynchronous. It is NEVER permissible to wait 
-for a slow device to complete. Asynchronous records perform the following steps:
+A complication of record processing is that some devices are intrinsically asynchronous.
+It is NEVER permissible to wait for a slow device to complete.
+Asynchronous records perform the following steps:
 
 \begin{enumerate}
-\item Initiate the I/O operation and set \verb|pact| \verb|TRUE|
+\item Initiate the I/O operation and set \verb|pact = TRUE|
 
 \item Determine a method for again calling process when the operation completes
 
@@ -69,7 +72,7 @@
 
 \item When process is called after the I/O operation complete record processing
 
-\item Set \verb|pact| \verb|FALSE| and return
+\item Set \verb|pact = FALSE| and return
 
 \end{enumerate}
 
@@ -77,35 +80,36 @@
 
 \section{Record Support and Device Support Entry Tables}
 
-Each record type has an associated set of record support routines. These routines are located via the data structures 
-defined in \verb|epics/share/epicsH/recSup.h|. The concept of record support routines isolates the \verb|iocCore| software 
-from the details of each record type. Thus new records can be defined and supported without affecting the IOC core 
-software.
-
-Each record type also has zero or more sets of device support routines. Record types without associated hardware, e.g. 
-calculation records, normally do not have any associated device support. Record types with associated hardware normally 
-have a  device support module for each device type. The concept of device support isolates IOC core software and even 
-record support from device specific details.
-
-Corresponding to each record type is a set of record support routines. The set of routines is the same for every record type. 
-These routines are located via a Record Support Entry Table (\index{RSET}\index{Record Support Entry Table}RSET), which has the following structure
+Each record type has an associated set of record support routines.
+These routines are located via the \verb|struct rset| data structure declared in \verb|recSup.h| and defined by the specific record type.
+This use of a record support vector table isolates the \verb|iocCore| software from the implementation details of each record type.
+Thus new record types can be defined without having to modify the IOC core software.
+
+Each record type also has zero or more sets of device support routines.
+Record types without associated hardware, e.g. calculation records, normally do not have any associated device support.
+Record types with associated hardware normally have a  device support module for each device type.
+The concept of device support isolates IOC core software and even record support from device specific details.
+
+Corresponding to each record type is a set of record support routines.
+The set of routines is the same for every record type.
+These routines are located via a Record Support Entry Table (\index{RSET}\index{Record Support Entry Table}RSET), which has the following structure:
 
 \begin{verbatim}
-rset {   /* record support entry table */
-    long     number;       /* number of support routine */
-    RECSUPFUN   report;       /* print report */
-    RECSUPFUN   init;         /* init support */
-    RECSUPFUN   init_record;  /* init record */
-    RECSUPFUN   process;      /* process record */
-    RECSUPFUN   special;     /* special processing */
-    RECSUPFUN   get_value;   /* OBSOLETE: Just leave NULL */
-    RECSUPFUN   cvt_dbaddr;   /* cvt  dbAddr */
+struct rset {   /* record support entry table */
+    long     number;            /* number of support routine */
+    RECSUPFUN   report;         /* print report */
+    RECSUPFUN   init;           /* init support */
+    RECSUPFUN   init_record;    /* init record */
+    RECSUPFUN   process;        /* process record */
+    RECSUPFUN   special;        /* special processing */
+    RECSUPFUN   get_value;      /* OBSOLETE: Just leave NULL */
+    RECSUPFUN   cvt_dbaddr;     /* cvt  dbAddr */
     RECSUPFUN   get_array_info;
     RECSUPFUN   put_array_info;
     RECSUPFUN   get_units;
     RECSUPFUN   get_precision;
     RECSUPFUN   get_enum_str;   /* get string from enum */
-    RECSUPFUN   get_enum_strs;   /* get all enum strings */
+    RECSUPFUN   get_enum_strs;  /* get all enum strings */
     RECSUPFUN   put_enum_str;   /* put enum from string */
     RECSUPFUN   get_graphic_double;
     RECSUPFUN   get_control_double;
@@ -119,35 +123,36 @@
 <record_type>RSET
 \end{verbatim}
 
-Any routines not needed for the particular record type should be initialized to the value \verb|NULL|. Look at the example below 
-for details.
+Any routines not needed for the particular record type should be initialized to the value \verb|NULL|.
+Look at the example below for details.
 
 Device support routines are located via a Device Support Entry Table (\index{DSET}\index{Device Support Entry Table}DSET), which has the following structure:
 
 \begin{verbatim}
 struct dset {   /* device support entry table */
-    long         number;   /* number of support routines */
-    DEVSUPFUN   report;   /* print report */
-    DEVSUPFUN   init;   /* init support */
+    long        number;     /* number of support routines */
+    DEVSUPFUN   report;     /* print report */
+    DEVSUPFUN   init;       /* init support */
     DEVSUPFUN   init_record;/* init record instance*/
     DEVSUPFUN    get_ioint_info;   /* get io interrupt info*/
     /* other functions are record dependent*/
 };
 \end{verbatim}
 
-Each device support module must define its associated DSET. The external name must be the same as the name which 
-appears in \verb|devSup.ascii|.
+Each device support module must define its associated DSET.
+The external name must be the same as the name which appears in \verb|devSup.ascii|.
 
-Any record support module which has associated device support must also include definitions for accessing its associated 
-device support modules. The field"\verb|dset|", which is located in \verb|dbCommon|, contains the address of the DSET. It is given a 
-value by \verb|iocInit|.
+Any record support module which has associated device support must also include definitions for accessing its associated device support modules.
+The field \verb|dset|, which is declared in \verb|dbCommon|, contains the address of the DSET.
+It is given a value by \verb|iocInit|.
 
 \section{Example Record Support Module}
 
-This section contains the skeleton of a record support package. The record type is \verb|xxx| and the record has the following 
-fields in addition to the \verb|dbCommon| fields: \verb|VAL|, \verb|PREC|, \verb|EGU|, \verb|HOPR|, \verb|LOPR|, \verb|HIHI|, \verb|LOLO|, \verb|HIGH|, \verb|LOW|, \verb|HHSV|, \verb|LLSV|, \verb|HSV|, 
-\verb|LSV|, \verb|HYST|, \verb|ADEL|, \verb|MDEL|, \verb|LALM|, \verb|ALST|, \verb|MLST|. These fields will have the same meaning as they have for the \verb|ai| record. 
-Consult the Record Reference manual for a description. 
+This section contains the skeleton of a record support package.
+The record type is \verb|xxx| and the record has the following fields in addition to the \verb|dbCommon| fields:
+\verb|VAL|, \verb|PREC|, \verb|EGU|, \verb|HOPR|, \verb|LOPR|, \verb|HIHI|, \verb|LOLO|, \verb|HIGH|, \verb|LOW|, \verb|HHSV|, \verb|LLSV|, \verb|HSV|, \verb|LSV|, \verb|HYST|, \verb|ADEL|, \verb|MDEL|, \verb|LALM|, \verb|ALST|, \verb|MLST|.
+These fields will have the same meaning as they have for the \verb|ai| record.
+Consult the Record Reference manual for a description.
 
 \subsection{Declarations}
 
@@ -208,14 +213,12 @@
 static void monitor(xxxRecord *pxxx);
 \end{verbatim}
 
-\index{RSET - example}The above declarations define the Record Support Entry Table (RSET), a template for the associated Device Support 
-Entry Table (DSET), and forward declarations to private routines.
-
-The RSET must be declared with an external name of \verb|xxxRSET|. It defines the record support routines supplied for this 
-record type. Note that forward declarations are given for all routines supported and a \verb|NULL| declaration for any routine not 
-supported.
-
-The template for the DSET is declared for use by this module. 
+\index{RSET - example}The above declarations define the Record Support Entry Table (RSET), a template for the associated Device Support Entry Table (DSET), and forward declarations to private routines.
+
+The RSET must be declared with an external name of \verb|xxxRSET|. It defines the record support routines supplied for this record type.
+Note that forward declarations are given for all routines supported and a \verb|NULL| declaration for any routine not supported.
+
+The template for the DSET is declared for use by this module.
 
 \subsection{init\_record}
 
@@ -246,16 +249,16 @@
 }
 \end{verbatim}
 
-This routine, which is called by \verb|iocInit| twice for each record of type \verb|xxx|, checks to see if it has a proper set of device 
-support routines and, if present, calls the \verb|init_record| entry of the DSET.
+This routine, which is called by \verb|iocInit| twice for each record of type \verb|xxx|, checks to see if it has a proper set of device support routines and, if present, calls the \verb|init_record| entry of the DSET.
 
-During the first call to \verb|init_record| (pass=0) only initializations relating to this record can be performed. During the 
-second call (pass=1) initializations that may refer to other records can be performed. Note also that during the second 
-pass, other records may refer to fields within this record. A good example of where these rules are important is a 
-waveform record. The \verb|VAL| field of a waveform record actually refers to an array. The waveform record support module 
-must allocate storage for the array. If another record has a database link referring to the waveform \verb|VAL| field then the 
-storage must be allocated before the link is resolved. This is accomplished by having the waveform record support 
-allocate the array during the first pass (pass=0) and having the link reference resolved during the second pass (pass=1).
+During the first call to \verb|init_record| (pass=0) only initializations relating to this record can be performed.
+During the second call (pass=1) initializations that may refer to other records can be performed.
+Note also that during the second pass, other records may refer to fields within this record.
+A good example of where these rules are important is a waveform record.
+The \verb|VAL| field of a waveform record actually refers to an array.
+The waveform record support module must allocate storage for the array.
+If another record has a database link referring to the waveform \verb|VAL| field then the storage must be allocated before the link is resolved.
+This is accomplished by having the waveform record support allocate the array during the first pass (pass=0) and having the link reference resolved during the second pass (pass=1).
 
 \subsection{process}
 
@@ -294,18 +297,20 @@
 }
 \end{verbatim}
 
-The record processing routines are the heart of the IOC software. The record specific process routine is called by 
-\verb|dbProcess| whenever it decides that a record should be processed. Process decides what record processing really means. 
-The above is a good example of what should be done. In addition to being called by \verb|dbProcess| the process routine may 
-also be called by asynchronous record completion routines.
+The record processing routines are the heart of the IOC software.
+The record specific process routine is called by \verb|dbProcess| whenever it decides that a record should be processed.
+Process decides what record processing really means.
+The above is a good example of what should be done.
+In addition to being called by \verb|dbProcess| the process routine may also be called by asynchronous record completion routines.
 
-The above model supports both synchronous and asynchronous device support routines. For example, if \verb|read_xxx| is an 
-asynchronous routine, the following sequence of events will occur:
+The above model supports both synchronous and asynchronous device support routines.
+For example, if \verb|read_xxx| is an asynchronous routine, the following sequence of events will occur:
 
 \begin{itemize}
 \item \verb|process| is called with \verb|pact| \verb|FALSE|
 
-\item \verb|read_xxx| is called. Since \verb|pact| is \verb|FALSE| it starts I/O, arranges callback, and sets \verb|pact| \verb|TRUE|
+\item \verb|read_xxx| is called.
+Since \verb|pact| is \verb|FALSE| it starts I/O, arranges callback, and sets \verb|pact| \verb|TRUE|
 
 \item \verb|read_xxx| returns
 
@@ -315,7 +320,8 @@
 
 \item Sometime later the callback occurs and \verb|process| is called again.
 
-\item \verb|read_xxx| is called. Since \verb|pact| is \verb|TRUE| it knows that it is a completion request.
+\item \verb|read_xxx| is called.
+Since \verb|pact| is \verb|TRUE| it knows that it is a completion request.
 
 \item \verb|read_xxx| returns
 
@@ -327,8 +333,8 @@
 
 \end{itemize}
 
-At this point the record has been completely processed. The next time \verb|process| is called everything starts all over from 
-the beginning.
+At this point the record has been completely processed.
+The next time \verb|process| is called everything starts all over from the beginning.
 
 \subsection{Miscellaneous Utility Routines}
 
@@ -359,8 +365,8 @@
 
 \index{get\_units - .example}
 \index{get\_graphic\_double - example}
-These are a few examples of various routines supplied by a typical record support package. The functions that must be 
-performed by the remaining routines are described in the next section.
+These are a few examples of various routines supplied by a typical record support package.
+The functions that must be performed by the remaining routines are described in the next section.
 
 \subsection{Alarm Processing}
 
@@ -416,13 +422,14 @@
 }
 \end{verbatim}
 
-\index{checkAlarms}This is a typical set of code for checking alarms conditions for an analog type record. The actual set of code can be very 
-record specific. Note also that other parts of the system can raise alarms. The algorithm is to always maximize alarm 
-severity, i.e. the highest severity outstanding alarm will be reported.
+\index{checkAlarms}This is a typical set of code for checking alarms conditions for an analog type record.
+The actual set of code can be very record specific.
+Note also that other parts of the system can raise alarms.
+The algorithm is to always maximize alarm severity, i.e. the highest severity outstanding alarm will be reported.
 
-The above algorithm also honors a hysteresis factor for the alarm. This is to prevent alarm storms from occurring in the 
-event that the current value is very near an alarm limit and noise makes it continually cross the limit. It honors the 
-hysteresis only when the value is going to a lower alarm severity.
+The above algorithm also honors a hysteresis factor for the alarm.
+This is to prevent alarm storms from occurring in the event that the current value is very near an alarm limit and noise makes it continually cross the limit.
+It honors the hysteresis only when the value is going to a lower alarm severity.
 
 Note the test:
 
@@ -433,30 +440,32 @@
 }
 \end{verbatim}
 
-\index{udf}Database common defines the field \index{UDF}UDF, which means that field VAL is undefined. The STAT and SEVR fields are 
-initialized as though \verb|recGblSetSevr(pxxx,UDF_ALARM,VALID_ALARM)|was called. Thus if the record is never 
-processed the record will be in an INVALID UNDEFINED alarm state. Field UDF is initialized to the value 1, i.e. TRUE. 
-Thus the above code will keep the record in the INVALID UNDEFINED alarm state as long as UDF is not given the 
-value 0.
-
-The UDF field means Undefined, i.e. the VAL field has never been given a value. When records are loaded into an ioc this 
-is the initial state of records. Whevever code gives a value to the VAL field it is also supposed to set UDF false. Unless a 
-particular record type has unusual semantics no code should set UDF true. UDF normally means that the field was never 
-given a value.
-
-For input records device support is responsible for obtaining an input value. If no input value can be obtained neither 
-record support nor device support sets UDF false. If device support reads a raw value it returns a value telling record 
-support to perform a conversion. After the record support sets VAL equal to the converted value, it sets UDF false. If 
-device support obtains a converted value that it writes to VAL, it sets UDF false.
-
-For output records either something outside record/device support writes to the VAL field or else VAL is given a value 
-because record support obtains a value via the OMSL field. In either case the code that writes to the VAL field sets UDF 
-false.
+\index{udf}Database common defines the field \index{UDF}UDF, which means that field VAL is undefined.
+The STAT and SEVR fields are initialized as though \verb|recGblSetSevr(pxxx,UDF_ALARM,VALID_ALARM)|was called.
+Thus if the record is never processed the record will be in an INVALID UNDEFINED alarm state.
+Field UDF is initialized to the value 1, i.e. TRUE.
+Thus the above code will keep the record in the INVALID UNDEFINED alarm state as long as UDF is not given the value 0.
+
+The UDF field means Undefined, i.e. the VAL field has never been given a value.
+When records are loaded into an ioc this is the initial state of records.
+Whevever code gives a value to the VAL field it is also supposed to set UDF false.
+Unless a particular record type has unusual semantics no code should set UDF true.
+UDF normally means that the field was never given a value.
+
+For input records device support is responsible for obtaining an input value.
+If no input value can be obtained neither record support nor device support sets UDF false.
+If device support reads a raw value it returns a value telling record support to perform a conversion.
+After the record support sets VAL equal to the converted value, it sets UDF false.
+If device support obtains a converted value that it writes to VAL, it sets UDF false.
+
+For output records either something outside record/device support writes to the VAL field or else VAL is given a value because record support obtains a value via the OMSL field.
+In either case the code that writes to the VAL field sets UDF false.
 
 Whenever database access writes to the VAL field it sets UDF false.
 
-Routine recGblSetSevr is called to raise alarms. It can be called by iocCore, record support, or device support. The code 
-that detects an alarm is responsible for raising the alarm.
+Routine recGblSetSevr is called to raise alarms.
+It can be called by iocCore, record support, or device support.
+The code that detects an alarm is responsible for raising the alarm.
 
 \subsection{Raising Monitors}
 
@@ -493,14 +502,16 @@
 }
 \end{verbatim}
 
-\index{monitor - example}All record types should call \verb|recGblResetAlarms| as shown. Note that \verb|nsta| and \verb|nsev| will have the value 0 after this 
-routine completes. This is necessary to ensure that alarm checking starts fresh after processing completes. The code also 
-takes care of raising alarm monitors when a record changes from an alarm state to the no alarm state. It is essential that 
-record support routines follow the above model or else alarm processing will not follow the rules.
+\index{monitor - example}All record types should call \verb|recGblResetAlarms| as shown.
+Note that \verb|nsta| and \verb|nsev| will have the value 0 after this routine completes.
+This is necessary to ensure that alarm checking starts fresh after processing completes.
+The code also takes care of raising alarm monitors when a record changes from an alarm state to the no alarm state.
+It is essential that record support routines follow the above model or else alarm processing will not follow the rules.
 
 Analog type records should also provide monitor and archive hysteresis fields as shown by this example.
 
-\verb|db_post_events| results in channel access issuing monitors for clients attached to the record and field. The call is
+\verb|db_post_events| results in channel access issuing monitors for clients attached to the record and field.
+The call is
 
 \begin{verbatim}
 int db_post_events(void *precord, void *pfield,
@@ -517,7 +528,8 @@
 
 \begin{description}
 
-\item \index{DBE\_ALARM}DBE\_ALARM - A change of alarm state has occured. This is set by \verb|recGblResetAlarms|.
+\item \index{DBE\_ALARM}DBE\_ALARM - A change of alarm state has occured.
+This is set by \verb|recGblResetAlarms|.
 
 \item \index{DBE\_LOG}DBE\_LOG - Archive change of state.
 
@@ -526,13 +538,14 @@
 \end{description}
 
 \end{description}
-IMPORTANT: The record support module is responsible for calling \verb|db_post_event| for any fields that change as a 
-result of record processing. Also it should NOT call \verb|db_post_event| for fields that do not change.
+IMPORTANT:
+The record support module is responsible for calling \verb|db_post_event| for any fields that change as a result of record processing.
+Also it should NOT call \verb|db_post_event| for fields that do not change.
 
 \section{Record Support Routines}
 
-This section describes the routines defined in the RSET. Any routine that does not apply to a specific record type must be 
-declared \verb|NULL|.
+This section describes the routines defined in the RSET.
+Any routine that does not apply to a specific record type must be declared \verb|NULL|.
 
 \subsection{Generate Report of Each Field in Record}
 
@@ -540,7 +553,8 @@
 report(void *precord);   /* addr of record*/
 \end{verbatim}
 
-\index{report - Record Support Routine}This routine is not used by most record types. Any action is record type specific.
+\index{report - Record Support Routine}This routine is not used by most record types.
+Any action is record type specific.
 
 \subsection{Initialize Record Processing}
 
@@ -548,8 +562,9 @@
 initialize(void);
 \end{verbatim}
 
-\index{init - Record Support Routine}This routine is called once at IOC initialization time. Any action is record type specific. Most record types do not need 
-this routine.
+\index{init - Record Support Routine}This routine is called once at IOC initialization time.
+Any action is record type specific.
+Most record types do not need this routine.
 
 \subsection{Initialize Specific Record}
 
@@ -559,15 +574,15 @@
     int     pass);
 \end{verbatim}
 
-\index{init\_record - record support routine}\verb|iocInit| calls this routine twice (pass=0 and pass=1) for each database record of the type handled by this routine. It must 
-perform the following functions:
+\index{init\_record - record support routine}\verb|iocInit| calls this routine twice (pass=0 and pass=1) for each database record of the type handled by this routine.
+It must perform the following functions:
 
 \begin{itemize}
 \item Check and/or issue initialization calls for the associated device support routines.
 
 \item Perform any record type specific initialization.
 
-\item During the first pass it can only perform initializations that affect the record referenced by precord. 
+\item During the first pass it can only perform initializations that affect the record referenced by precord.
 
 \item During the second pass it can perform initializations that affect other records.
 
@@ -589,16 +604,20 @@
     int   after);/*(FALSE,TRUE)=>(Before,After)Processing*/
 \end{verbatim}
 
-\index{special - Record Support Routine}This routine implements the record type specific special processing for the field referred to by \verb|dbAddr|. Note that it is 
-called twice. Once before any changes are made to the associated field and once after. File \verb|special.h| defines special 
-types. This routine is only called for user special fields, i.e. fields with \verb|SPC_xxx| \textgreater{}= 100. A field is declared special in the 
-ASCII record definition file. New values should not by added to \verb|special.h|, instead use \verb|SPC_MOD|.
+\index{special - Record Support Routine}This routine implements the record type specific special processing for the field referred to by \verb|dbAddr|.
+Note that it is called twice.
+Once before any changes are made to the associated field and once after.
+File \verb|special.h| defines special types.
+This routine is only called for user special fields, i.e. fields with \verb|SPC_xxx| \textgreater{}= 100.
+A field is declared special in the ASCII record definition file.
+New values should not by added to \verb|special.h|, instead use \verb|SPC_MOD|.
 
 The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified.
 
 \subsection{Get Value}
 
-This routine is no longer used. It should be left as a NULL procedure in the record support entry table.
+This routine is no longer used.
+It should be left as a NULL procedure in the record support entry table.
 
 \subsection{Convert dbAddr Definitions}
 
@@ -606,18 +625,20 @@
 cvt_dbaddr(struct dbAddr *paddr);
 \end{verbatim}
 
-\index{cvt\_dbaddr - Record Support Routine}This routine is called by \verb|dbNameToAddr| if the field has special set equal to \verb|SPC_DBADDR|. A typical use is when a field 
-refers to an array. This routine can change any combination of the \verb|dbAddr| fields: \verb|no_elements|, \verb|field_type|, 
-\verb|field_size|, \verb|special,pfield, |and\verb| dbr_type|. For example if the \verb|VAL| field of a waveform record is passed to 
-\verb|dbNameToAddr|, \verb|cvt_dbaddr| would change \verb|dbAddr| so that it refers to the actual array rather then \verb|VAL|.
+\index{cvt\_dbaddr - Record Support Routine}This routine is called by \verb|dbNameToAddr| if the field has special set equal to \verb|SPC_DBADDR|.
+A typical use is when a field refers to an array.
+This routine can change any combination of the \verb|dbAddr| fields:
+\verb|no_elements|, \verb|field_type|, \verb|field_size|, \verb|special,pfield, |and\verb| dbr_type|.
+For example if the \verb|VAL| field of a waveform record is passed to \verb|dbNameToAddr|, \verb|cvt_dbaddr| would change \verb|dbAddr| so that it refers to the actual array rather then \verb|VAL|.
 
 The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified.
 
 NOTES:
 
 \begin{itemize}
-\item Channel access calls db\_name\_to\_addr, which is part of old database access. Db\_name\_to\_addr calls 
-dbNameToAddr. This is done when a client connects to the record.
+\item Channel access calls \verb|db_name_to_addr|, which is part of old database access.
+\verb|db_name_to_addr| calls \verb|dbNameToAddr|.
+This is done when a client connects to the record.
 
 \item no\_elements must be set to the maximum number of elements that will ever be stored in the array.
 
@@ -632,11 +653,12 @@
     long   *offset);
 \end{verbatim}
 
-\index{get\_array\_info - Record Support Routine}This routine returns the current number of elements and the offset of the first value of the specified array. The offset field 
-is meaningful if the array is actually a circular buffer.
+\index{get\_array\_info - Record Support Routine}This routine returns the current number of elements and the offset of the first value of the specified array.
+The offset field is meaningful if the array is actually a circular buffer.
 
-The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified. It is 
-permissible for \verb|get_array_info| to change \verb|pfield|. This feature can be used to implement double buffering.
+The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified.
+It is permissible for \verb|get_array_info| to change \verb|pfield|.
+This feature can be used to implement double buffering.
 
 \index{get\_array\_info - Record Support Routine}
 When an array field is being written \verb|get_array_info| is called before the field values are changed.
@@ -673,8 +695,9 @@
     long   *precision);
 \end{verbatim}
 
-\index{get\_precision - Record Support Routine}This routine gets the precision, i.e. number of decimal places, which should be used to convert the field value to an ASCII 
-string. \verb|recGblGetPrec| should be called for fields not directly related to the value field.
+\index{get\_precision - Record Support Routine}This routine gets the precision, i.e.
+number of decimal places, which should be used to convert the field value to an ASCII string.
+\verb|recGblGetPrec| should be called for fields not directly related to the value field.
 
 The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified.
 
@@ -686,7 +709,8 @@
     char  *p);
 \end{verbatim}
 
-\index{get\_enum\_str - record Support Routine}This routine sets \verb|*p| equal to the ASCII string for the field value. The field must have type \verb|DBF_ENUM|.
+\index{get\_enum\_str - record Support Routine}This routine sets \verb|*p| equal to the ASCII string for the field value.
+The field must have type \verb|DBF_ENUM|.
 
 Look at the code for the \verb|bi| or \verb|mbbi| records for examples.
 
@@ -714,8 +738,8 @@
     char  *p);
 \end{verbatim}
 
-\index{put\_enum\_str - Record Support Routine}Given an ASCII string, this routine updates the database field. It compares the string with the string values associated with 
-each enumerated value and if it finds a match sets the database field equal to the index of the string which matched.
+\index{put\_enum\_str - Record Support Routine}Given an ASCII string, this routine updates the database field.
+It compares the string with the string values associated with each enumerated value and if it finds a match sets the database field equal to the index of the string which matched.
 
 Look at the code for the \verb|bi| or \verb|mbbi| records for examples.
 
@@ -729,8 +753,8 @@
     struct dbr_grDouble  *p);   /* addr of return info*/
 \end{verbatim}
 
-\index{get\_graphic\_double - Record Support Routine}This routine fills in the graphics related fields of structure \verb|dbr_grDouble|. \verb|recGblGetGraphicDouble| should be 
-called for fields not directly related to the value field.
+\index{get\_graphic\_double - Record Support Routine}This routine fills in the graphics related fields of structure \verb|dbr_grDouble|.
+\verb|recGblGetGraphicDouble| should be called for fields not directly related to the value field.
 
 The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified.
 
@@ -742,8 +766,8 @@
     struct dbr_ctrlDouble  *p);  /* addr of return info*/
 \end{verbatim}
 
-\index{get\_control\_double - Record Support Routine}This routine gives values to all fields of structure \verb|dbr_ctrlDouble|. \verb|recGblGetControlDouble| should be called 
-for fields not directly related to the value field.
+\index{get\_control\_double - Record Support Routine}This routine gives values to all fields of structure \verb|dbr_ctrlDouble|.
+\verb|recGblGetControlDouble| should be called for fields not directly related to the value field.
 
 The database access routine, \verb|dbGetFieldIndex| can be used to determine which field is being modified.
 
@@ -762,26 +786,30 @@
 \section{Global Record Support Routines}
 
 \index{Global Record Support Routines}
-A number of global record support routines are available. These routines are intended for use by the record specific 
-processing routines but can be called by any routine that wishes to use their services.
+A number of global record support routines are available.
+These routines are intended for use by the record specific processing routines but can be called by any routine that wishes to use their services.
 
 The name of each of these routines begins with ``\verb|recGbl|".
 
 \subsection{Alarm Status and Severity}
 
-Alarms may be raised in many different places during the course of record processing. The algorithm is to maximize the 
-alarm severity, i.e. the highest severity outstanding alarm is raised. If more than one alarm of the same severity is found 
-then the first one is reported. This means that whenever a code fragment wants to raise an alarm, it does so only if the 
-alarm severity it will declare is greater then that already existing. Four fields (in database common) are used to implement 
-alarms: \verb|sevr|, \verb|stat|, \verb|nsev|, and \verb|nsta|. The first two are the status and severity after the record is completely processed. 
-The last two fields (\verb|nsta| and \verb|nsev|) are the status and severity values to set during record processing. Two routines are 
-used for handling alarms. Whenever a routine wants to raise an alarm it calls \verb|recGblSetSevr|. This routine will only 
-change \verb|nsta| and \verb|nsev| if it will result in the alarm severity being increased. At the end of processing, the record support 
-module must call \verb|recGblResetAlarms|. This routine sets \verb|stat = nsta|, \verb|sevr = nsev|, \verb|nsta= 0|, and \verb|nsev = 0|. If \verb|stat| 
-or \verb|sevr| has changed value since the last call it calls \verb|db_post_event| for \verb|stat| and \verb|sevr| and returns a value of 
-\verb|DBE_ALARM|. If no change occured it returns 0. Thus after calling \verb|recGblResetAlarms| everything is ready for raising 
-alarms the next time the record is processed. The example record support module presented above shows how these 
-macros are used.
+Alarms may be raised in many different places during the course of record processing.
+The algorithm is to maximize the alarm severity, i.e. the highest severity outstanding alarm is raised.
+If more than one alarm of the same severity is found then the first one is reported.
+This means that whenever a code fragment wants to raise an alarm, it does so only if the alarm severity it will declare is greater then that already existing.
+Four fields (in database common) are used to implement alarms:
+\verb|sevr|, \verb|stat|, \verb|nsev|, and \verb|nsta|.
+The first two are the status and severity after the record is completely processed.
+The last two fields (\verb|nsta| and \verb|nsev|) are the status and severity values to set during record processing.
+Two routines are used for handling alarms.
+Whenever a routine wants to raise an alarm it calls \verb|recGblSetSevr|.
+This routine will only change \verb|nsta| and \verb|nsev| if it will result in the alarm severity being increased.
+At the end of processing, the record support module must call \verb|recGblResetAlarms|.
+This routine sets \verb|stat = nsta|, \verb|sevr = nsev|, \verb|nsta= 0|, and \verb|nsev = 0|.
+If \verb|stat| or \verb|sevr| has changed value since the last call it calls \verb|db_post_event| for \verb|stat| and \verb|sevr| and returns a value of \verb|DBE_ALARM|.
+If no change occured it returns 0.
+Thus after calling \verb|recGblResetAlarms| everything is ready for raising alarms the next time the record is processed.
+The example record support module presented above shows how these macros are used.
 
 \begin{verbatim}
 recGblSetSevr(
@@ -790,7 +818,7 @@
 short   nsevr);
 \end{verbatim}
 
-\index{recGblSetSevr}Returns: (\verb|TRUE|, \verb|FALSE|) if (did, did not) change \verb|nsta| and \verb|nsev|.
+\index{recGblSetSevr}Returns \verb|TRUE| if it changed \verb|nsta| and/or \verb|nsev|, \verb|FALSE| if it did not change them.
 
 \begin{verbatim}
 unsigned short recGblResetAlarms(void  *precord);
@@ -800,9 +828,10 @@
 
 \subsection{Alarm Acknowledgment}
 
-Database common contains two additional alarm related fields: \verb|acks| (Highest severity unacknowledged alarm) and 
-\verb|ackt| (does transient alarm need to be acknowledged). These field are handled by \verb|iocCore| and \verb|recGblResetAlarms| 
-and are not the responsibility of record support. These fields are intended for use by the alarm handler.
+Database common contains two additional alarm related fields:
+\verb|acks| (Highest severity unacknowledged alarm) and \verb|ackt| (does transient alarm need to be acknowledged).
+These field are handled by \verb|iocCore| and \verb|recGblResetAlarms| and are not the responsibility of record support.
+These fields are intended for use by the alarm handler.
 
 \subsection{Generate Error: Process Variable Name, Caller, Message}
 
@@ -815,8 +844,8 @@
     char   *pcaller_name); /* calling routine name */
 \end{verbatim}
 
-\index{recGblDbaddrError}This routine interfaces with the system wide error handling system to display the following information: Status 
-information, process variable name, calling routine.
+\index{recGblDbaddrError}This routine interfaces with the system wide error handling system to display the following information:
+Status information, process variable name, calling routine.
 
 \subsection{Generate Error: Status String, Record Name, Caller}
 SUGGESTION: use errlogPrintf instead of this for new code.
@@ -829,8 +858,8 @@
 
 \index{errlogPrintf}
 \index{recGblRecordError}
-This routine interfaces with the system wide error handling system to display the following information: Status 
-information, record name, calling routine.
+This routine interfaces with the system wide error handling system to display the following information:
+Status information, record name, calling routine.
 
 \subsection{Generate Error: Record Name, Caller, Record Support Message}
 SUGGESTION: use errlogPrintf instead of this for new code.
@@ -844,8 +873,8 @@
 
 \index{errlogPrintf}
 \index{recGblRecsupError}
-This routine interfaces with the system wide error handling system to display the following information: Status 
-information, record name, calling routine, record support entry name.
+This routine interfaces with the system wide error handling system to display the following information:
+Status information, record name, calling routine, record support entry name.
 
 \subsection{Get Graphics Double}
 
@@ -900,8 +929,8 @@
 \index{recGblGetTimeStamp}This routine gets the current time stamp and puts it in the record It does the following:
 
 \begin{itemize}
-\item If TSEL is not a constant link and TSEL refers to the TIME field of a record, the time is obtained from the record 
-reference by TSEL and this put in field TIME. The routine then returns.
+\item If TSEL is not a constant link and TSEL refers to the TIME field of a record, the time is obtained from the record reference by TSEL and this put in field TIME.
+The routine then returns.
 
 \item If TSEL is not a constant link dbGetLink is called and the value put in field TSE.
 
@@ -929,5 +958,6 @@
     void   *pdest);
 \end{verbatim}
 
-\index{recGblInitConstantLink}Initialize a constant link. This routine is usually called by \verb|init_record| (or by associated device support) to initialize 
-the field associated with a constant link. It returns(FALSE, TRUE) if it (did not, did) modify the destination.
+\index{recGblInitConstantLink}Initialize a constant link.
+This routine is usually called by \verb|init_record| (or by associated device support) to initialize the field associated with a constant link.
+It returns(FALSE, TRUE) if it (did not, did) modify the destination.