浏览代码

benchmark: documentation for register parameter

Daniel-Constantin Mierla 7 年之前
父节点
当前提交
9c01580fd8
共有 1 个文件被更改,包括 23 次插入0 次删除
  1. 23 0
      src/modules/benchmark/doc/benchmark_admin.xml

+ 23 - 0
src/modules/benchmark/doc/benchmark_admin.xml

@@ -156,6 +156,29 @@ modparam("benchmark", "loglevel", 4)
 		</para>
 	</section>
 
+	<section id="benchmark.p.register">
+		<title><varname>register</varname> (str)</title>
+		<para>
+			Register a timer id at startup. Required when using the start/log
+			functions via Kemi framework. This parameter can be set many
+			times to register several timer ids.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>NONE</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>register</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("benchmark", "register", "test")
+modparam("benchmark", "register", "auth")
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 	<section>
 	<title>Functions</title>