Просмотр исходного кода

cfgutils: document second optional string for hashing on lock functions family [skip ci]

Victor Seva 1 год назад
Родитель
Сommit
235591cd70
1 измененных файлов с 13 добавлено и 5 удалено
  1. 13 5
      src/modules/cfgutils/doc/cfgutils_admin.xml

+ 13 - 5
src/modules/cfgutils/doc/cfgutils_admin.xml

@@ -485,10 +485,10 @@ if(is_gflag("4"))
 		</example>
 		</example>
 	</section>
 	</section>
 	<section id="cfgutils.f.lock">
 	<section id="cfgutils.f.lock">
-		<title><function moreinfo="none">lock(key)</function></title>
+		<title><function moreinfo="none">lock(key [, key2])</function></title>
 		<para>
 		<para>
 		Lock the key. Can be used to synchronize operations in config file,
 		Lock the key. Can be used to synchronize operations in config file,
-		a hash id is computed over the key and appropriate lock is set in the
+		a hash id is computed over the keys and appropriate lock is set in the
 		lock array controlled by parameter "lock_set_size". Do not use lock()
 		lock array controlled by parameter "lock_set_size". Do not use lock()
 		after another lock() unless you are sure the keys hit different array
 		after another lock() unless you are sure the keys hit different array
 		entries.
 		entries.
@@ -497,6 +497,9 @@ if(is_gflag("4"))
 		<quote>key</quote> can be static string or string with PVs.
 		<quote>key</quote> can be static string or string with PVs.
 		</para>
 		</para>
 		<para>
 		<para>
+		<quote>key2</quote> is optional and can be static string or string with PVs.
+		</para>
+		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
 		ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
 		</para>
 		</para>
@@ -510,7 +513,7 @@ lock("$rU");
 		</example>
 		</example>
 	</section>
 	</section>
 	<section id="cfgutils.f.trylock">
 	<section id="cfgutils.f.trylock">
-		<title><function moreinfo="none">trylock(key)</function></title>
+		<title><function moreinfo="none">trylock(key [, key2])</function></title>
 		<para>
 		<para>
 		Try to lock the key. If the lock can not be obtained (possibly already locked),
 		Try to lock the key. If the lock can not be obtained (possibly already locked),
 		the function returns an error and script execution continues.
 		the function returns an error and script execution continues.
@@ -519,6 +522,9 @@ lock("$rU");
 		<quote>key</quote> can be static string or string with PVs.
 		<quote>key</quote> can be static string or string with PVs.
 		</para>
 		</para>
 		<para>
 		<para>
+		<quote>key2</quote> is optional and can be static string or string with PVs.
+		</para>
+		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
 		ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
 		</para>
 		</para>
@@ -535,7 +541,7 @@ if (trylock("$rU")) {
 		</example>
 		</example>
 	</section>
 	</section>
 	<section id="cfgutils.f.unlock">
 	<section id="cfgutils.f.unlock">
-		<title><function moreinfo="none">unlock(key)</function></title>
+		<title><function moreinfo="none">unlock(key [, key2])</function></title>
 		<para>
 		<para>
 		Unlock the key.
 		Unlock the key.
 		</para>
 		</para>
@@ -543,6 +549,9 @@ if (trylock("$rU")) {
 		<quote>key</quote> can be static string or string with PVs.
 		<quote>key</quote> can be static string or string with PVs.
 		</para>
 		</para>
 		<para>
 		<para>
+		<quote>key2</quote> is optional and can be static string or string with PVs.
+		</para>
+		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
 		ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
 		ONREPLY_ROUTE, BRANCH_ROUTE and LOCAL_ROUTE.
 		</para>
 		</para>
@@ -854,4 +863,3 @@ if (rand_event()) {
 	</section>
 	</section>
 </section>
 </section>
 </chapter>
 </chapter>
-