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

Clean up permissive POD links

Browse Source
This commit is contained in:
Andrew Johnson
2019-10-10 15:02:06 -04:00
parent 4816a3c04b
commit 47f295fecb
1 changed files with 15 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/std/rec/permissiveRecord.dbd.pod
+15 -17
View File
@@ -14,7 +14,7 @@ example would be a sequence program server and an operator interface client. By
using multiple permissive records a sequence program can communicate its current
state to the client.
B<Note that this record is deprecated and will probably be removed from future EPICS base releases.>
B<Note this record is deprecated and is likely to be removed in a future EPICS release.>
=head2 Contents
@@ -59,19 +59,17 @@ B<Note that this record is deprecated and will probably be removed from future E
=cut
recordtype(permissive) {
include "dbCommon.dbd"
include "dbCommon.dbd"
=head2 Parameter Fields
=head3 Scan Parameters
The permissive record has the standard fields for specifying under what
circumstances the record will be processed. These fields are listed in
L<Scan Fields|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_dbCommon#Scan_Fields>.
In addition,
L<Scanning Specification|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_Concepts#Scanning_Specification>
explains how these fields are used. Since the permissive record supports
no direct interfaces to hardware, its SCAN field cannot be C<<< I/O Intr >>>.
circumstances the record will be processed. These fields are listed in
L<Scan Fields>. In addition, L<Scanning Specification> explains how these
fields are used. Since the permissive record supports no direct interfaces to
hardware, its SCAN field cannot be C<<< I/O Intr >>>.
=head3 Client-server Parameters
@@ -106,9 +104,9 @@ Note that when WFLG is ON, the client program ''must not'' turn VAL to on.
=head3 Operator Display Parameters
The label field (LABL) contains a string given to it that should describe the
record in further detail. In addition to the DESC field. See
L<Fields Common to All Record Types|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_dbCommon#Fields_Common_to_All_Record_Types>
for more on the record name (NAME) and description (DESC) fields.
record in further detail. In addition to the DESC field. See
L<Fields Common to All Record Types> for more on the record name (NAME) and
description (DESC) fields.
=fields LABL, NAME, DESC
@@ -124,9 +122,9 @@ for more on the record name (NAME) and description (DESC) fields.
=head3 Alarm Parameters
The Permissive record has the alarm parameters common to all record types.
L<Alarm Fields|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_dbCommon#Alarm_Fields>
lists other fields related to a alarms that are common to all record types.
The Permissive record has the alarm parameters common to all record types.
L<Alarm Fields> lists other fields related to a alarms that are common to all
record types.
=head3 Run-time Parameters
@@ -158,9 +156,9 @@ OLFG.
long (*process)(struct dbCommon *precord)
process sets UDF to FALSE, triggers monitors on VAL and WFLG when they change,
and scans the forward link if necessary.
C<<< process() >>> sets UDF to FALSE, triggers monitors on VAL and WFLG when
they change, and scans the forward link if necessary.
=cut
}
}