浏览代码

usrloc: doc fixes

* add doc for parameter reg_id_column
* fix title for parameter partition_column
Bastian Triller 5 年之前
父节点
当前提交
305ba1b23b
共有 1 个文件被更改,包括 21 次插入1 次删除
  1. 21 1
      src/modules/usrloc/doc/usrloc_admin.xml

+ 21 - 1
src/modules/usrloc/doc/usrloc_admin.xml

@@ -456,6 +456,26 @@ modparam("usrloc", "instance_column", "myinstance")
 		</example>
 		</example>
 	</section>
 	</section>
 
 
+	<section id="usrloc.p.reg_id_column">
+		<title><varname>reg_id_column</varname> (string)</title>
+		<para>
+		Name of database table column containing the value for reg-id.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>reg_id</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>reg_id_column</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("usrloc", "reg_id_column", "r_id")
+...
+</programlisting>
+		</example>
+	</section>
+
 	<section id="usrloc.p.server_id_column">
 	<section id="usrloc.p.server_id_column">
 		<title><varname>server_id_column</varname> (string)</title>
 		<title><varname>server_id_column</varname> (string)</title>
 		<para>
 		<para>
@@ -527,7 +547,7 @@ modparam("usrloc", "keepalive_column", "kalive")
 		</emphasis>
 		</emphasis>
 		</para>
 		</para>
 		<example>
 		<example>
-		<title>Set <varname>partitioncolumn</varname> parameter</title>
+		<title>Set <varname>partition_column</varname> parameter</title>
 		<programlisting format="linespecific">
 		<programlisting format="linespecific">
 ...
 ...
 modparam("usrloc", "partition_column", "part")
 modparam("usrloc", "partition_column", "part")