EPICS_base/pva2pva
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

finalize doxygen

Browse Source
This commit is contained in:
Michael Davidsaver
2019-10-31 11:14:24 -07:00
parent 21ae754869
commit 536f4dd02f
3 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/Doxyfile
View File

@ -38,7 +38,7 @@ PROJECT_NAME = pva2pva
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 1.2.1 PROJECT_NUMBER = 1.2.2
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

3
documentation/mainpage.dox
View File

@ -11,7 +11,8 @@ runs inside an EPICS IOC process and allows clients
to make requests to access the Process Variables (PVs) to make requests to access the Process Variables (PVs)
within. within.
Documentation of @ref qsrv_config including @ref qsrv_group_def Documentation of @ref qsrv_config including @ref qsrv_group_def ,
@ref qsrv_aslib
and @ref qsrv_link configuration. and @ref qsrv_link configuration.
- @ref release_notes - @ref release_notes

14
documentation/qsrvpage.dox
View File

@ -166,7 +166,7 @@ record(ai, "...") {
QSRV will enforce an optional access control policy file (.acf) loaded by the usual means (cf. asSetFilename() ). QSRV will enforce an optional access control policy file (.acf) loaded by the usual means (cf. asSetFilename() ).
This policy is applied to both Single and Group PVs. With Group PVs, restrictions are not defined for the group, This policy is applied to both Single and Group PVs. With Group PVs, restrictions are not defined for the group,
but rather for the individual member records. So the same policy will be applied regardess of how a record but rather for the individual member records. The same policy will be applied regardess of how a record
is accessed (individually, or through a group). is accessed (individually, or through a group).
Policy application differs from CA (RSRV) in several ways: Policy application differs from CA (RSRV) in several ways:
@ -179,6 +179,16 @@ against the list of groups of which the client username is a member. Username t
to QSRV, and depends on IOC host authentication configuration. Note that this is still based on the client provided to QSRV, and depends on IOC host authentication configuration. Note that this is still based on the client provided
username string. username string.
@code
UAG(special) {
someone, "role/op"
}
@endcode
The "special" UAG will match CA or PVA clients with the username "someone".
It will also match a PVA client if the client provided username is a member
of the "op" group (supported on POSIX targets and Windows).
@subsection qsrv_link PVAccess Links @subsection qsrv_link PVAccess Links
When built against Base >= 3.16.1, support is enabled for PVAccess links, When built against Base >= 3.16.1, support is enabled for PVAccess links,
@ -187,8 +197,6 @@ for PVA links is quite different.
@note The "dbjlr" and "dbpvar" IOC shell command provide information about PVA links in a running IOC. @note The "dbjlr" and "dbpvar" IOC shell command provide information about PVA links in a running IOC.
@warning The PVA Link syntax shown below is provisional and subject to change.
A simple configuration using defaults is A simple configuration using defaults is
@code @code