Browse Source

dispatcher(k): corrected setid_pvname parameter name

- readme listed it as setid_pvar, the source code expected setid_pvname
- reported by Dan B.
Daniel-Constantin Mierla 13 years ago
parent
commit
e1149b0586
2 changed files with 13 additions and 13 deletions
  1. 9 9
      modules_k/dispatcher/README
  2. 4 4
      modules_k/dispatcher/doc/dispatcher_admin.xml

+ 9 - 9
modules_k/dispatcher/README

@@ -51,7 +51,7 @@ Carsten Bock
               3.14. dstid_avp (str)
               3.14. dstid_avp (str)
               3.15. attrs_avp (str)
               3.15. attrs_avp (str)
               3.16. hash_pvar (str)
               3.16. hash_pvar (str)
-              3.17. setid_pvar (str)
+              3.17. setid_pvname (str)
               3.18. ds_ping_method (string)
               3.18. ds_ping_method (string)
               3.19. ds_ping_from (string)
               3.19. ds_ping_from (string)
               3.20. ds_ping_interval (int)
               3.20. ds_ping_interval (int)
@@ -118,7 +118,7 @@ Carsten Bock
    1.15. Set the "attrs_avp" parameter
    1.15. Set the "attrs_avp" parameter
    1.16. Use $avp(i:273) for hashing:
    1.16. Use $avp(i:273) for hashing:
    1.17. Use combination of PVs for hashing:
    1.17. Use combination of PVs for hashing:
-   1.18. Set the "setid_pvar" parameter
+   1.18. Set the "setid_pvname" parameter
    1.19. Set the "ds_ping_method" parameter
    1.19. Set the "ds_ping_method" parameter
    1.20. Set the "ds_ping_from" parameter
    1.20. Set the "ds_ping_from" parameter
    1.21. Set the "ds_ping_interval" parameter
    1.21. Set the "ds_ping_interval" parameter
@@ -165,7 +165,7 @@ Chapter 1. Admin Guide
         3.14. dstid_avp (str)
         3.14. dstid_avp (str)
         3.15. attrs_avp (str)
         3.15. attrs_avp (str)
         3.16. hash_pvar (str)
         3.16. hash_pvar (str)
-        3.17. setid_pvar (str)
+        3.17. setid_pvname (str)
         3.18. ds_ping_method (string)
         3.18. ds_ping_method (string)
         3.19. ds_ping_from (string)
         3.19. ds_ping_from (string)
         3.20. ds_ping_interval (int)
         3.20. ds_ping_interval (int)
@@ -263,7 +263,7 @@ Chapter 1. Admin Guide
    3.14. dstid_avp (str)
    3.14. dstid_avp (str)
    3.15. attrs_avp (str)
    3.15. attrs_avp (str)
    3.16. hash_pvar (str)
    3.16. hash_pvar (str)
-   3.17. setid_pvar (str)
+   3.17. setid_pvname (str)
    3.18. ds_ping_method (string)
    3.18. ds_ping_method (string)
    3.19. ds_ping_from (string)
    3.19. ds_ping_from (string)
    3.20. ds_ping_interval (int)
    3.20. ds_ping_interval (int)
@@ -509,16 +509,16 @@ Note
  modparam("dispatcher", "hash_pvar", "hash the $fU@$ci")
  modparam("dispatcher", "hash_pvar", "hash the $fU@$ci")
  ...
  ...
 
 
-3.17. setid_pvar (str)
+3.17. setid_pvname (str)
 
 
    The name of the PV where to store the set ID (group ID) when calling
    The name of the PV where to store the set ID (group ID) when calling
    ds_is_from_list() with no parameter.
    ds_is_from_list() with no parameter.
 
 
    Default value is "null" - don't set PV.
    Default value is "null" - don't set PV.
 
 
-   Example 1.18. Set the "setid_pvar" parameter
+   Example 1.18. Set the "setid_pvname" parameter
  ...
  ...
- modparam("dispatcher", "setid_pvar", "$var(setid)")
+ modparam("dispatcher", "setid_pvname", "$var(setid)")
  ...
  ...
 
 
 3.18. ds_ping_method (string)
 3.18. ds_ping_method (string)
@@ -811,8 +811,8 @@ failure_route[tryagain] {
 
 
    Parameter groupid is optional, when it is missing, then the matching
    Parameter groupid is optional, when it is missing, then the matching
    will be done against all addresses in all groups. Upon a match, the
    will be done against all addresses in all groups. Upon a match, the
-   variable specified by 'setid_pvar' parameter will be set to groupid of
-   matching address.
+   variable specified by 'setid_pvname' parameter will be set to groupid
+   of matching address.
 
 
    This function can be used from ANY_ROUTE.
    This function can be used from ANY_ROUTE.
 
 

+ 4 - 4
modules_k/dispatcher/doc/dispatcher_admin.xml

@@ -455,7 +455,7 @@ modparam("dispatcher", "force_dst", 1)
  		</example>
  		</example>
  	</section>
  	</section>
  	<section>
  	<section>
- 		<title><varname>setid_pvar</varname> (str)</title>
+ 		<title><varname>setid_pvname</varname> (str)</title>
  		<para>
  		<para>
 		The name of the PV where to store the set ID (group ID) when calling
 		The name of the PV where to store the set ID (group ID) when calling
 		ds_is_from_list() with no parameter.
 		ds_is_from_list() with no parameter.
@@ -466,10 +466,10 @@ modparam("dispatcher", "force_dst", 1)
  		</emphasis>
  		</emphasis>
  		</para>
  		</para>
  		<example>
  		<example>
- 		<title>Set the <quote>setid_pvar</quote> parameter</title>
+ 		<title>Set the <quote>setid_pvname</quote> parameter</title>
  <programlisting format="linespecific">
  <programlisting format="linespecific">
  ...
  ...
- modparam("dispatcher", "setid_pvar", "$var(setid)")
+ modparam("dispatcher", "setid_pvname", "$var(setid)")
  ...
  ...
  </programlisting>
  </programlisting>
  		</example>
  		</example>
@@ -965,7 +965,7 @@ failure_route[tryagain] {
 		<para>
 		<para>
 		Parameter groupid is optional, when it is missing, then the matching
 		Parameter groupid is optional, when it is missing, then the matching
 		will be done against all addresses in all groups. Upon a match, the
 		will be done against all addresses in all groups. Upon a match, the
-		variable specified by 'setid_pvar' parameter will be set to groupid
+		variable specified by 'setid_pvname' parameter will be set to groupid
 		of matching address.
 		of matching address.
  		</para>
  		</para>
 		<para>
 		<para>