From 536f4dd02f7fb3f117fda6bdbe1bbe51ca1257ca Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Thu, 31 Oct 2019 11:14:24 -0700 Subject: [PATCH] finalize doxygen --- documentation/Doxyfile | 2 +- documentation/mainpage.dox | 3 ++- documentation/qsrvpage.dox | 14 +++++++++++--- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/documentation/Doxyfile b/documentation/Doxyfile index 8ccaeef..6649643 100644 --- a/documentation/Doxyfile +++ b/documentation/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = pva2pva # could be handy for archiving the generated documentation or if some version # 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 # for a project that appears at the top of each page and should give viewer a diff --git a/documentation/mainpage.dox b/documentation/mainpage.dox index fab4bef..71d8f2f 100644 --- a/documentation/mainpage.dox +++ b/documentation/mainpage.dox @@ -11,7 +11,8 @@ runs inside an EPICS IOC process and allows clients to make requests to access the Process Variables (PVs) 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. - @ref release_notes diff --git a/documentation/qsrvpage.dox b/documentation/qsrvpage.dox index 451c6ef..d5993b7 100644 --- a/documentation/qsrvpage.dox +++ b/documentation/qsrvpage.dox @@ -166,7 +166,7 @@ record(ai, "...") { 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, -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). 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 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 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. -@warning The PVA Link syntax shown below is provisional and subject to change. - A simple configuration using defaults is @code