[mid-]registrar: add migration hints for new named flags

Author: rvlad-patrascu

lib/reg/doc/lookup_flags.xml

@@ -3,8 +3,8 @@
 <itemizedlist>
 <listitem>
 	<para>
-	<emphasis>'no-branches'</emphasis> - this flag controls how
-	the &reg_lookup_f; function processes multiple contacts.
+	<emphasis>'no-branches'</emphasis> - (old <emphasis>b</emphasis> flag) this
+	flag controls how the &reg_lookup_f; function processes multiple contacts.
 	If there are
 	multiple contacts for the given username in usrloc and this
 	flag is not set, Request-URI will be overwritten with the
@@ -18,8 +18,8 @@
 
 <listitem>
 	<para>
-	<emphasis>'to-branches-only'</emphasis> - this flags forces
-	all found contacts to be uploaded only as branches (in the
+	<emphasis>'to-branches-only'</emphasis> - (old <emphasis>B</emphasis> flag)
+	this flags forces all found contacts to be uploaded only as branches (in the
 	destination set) and not at all in the R-URI of the
 	current message.  Using this option allows the &reg_lookup_f; function to
 	also be used in the context of a SIP reply.
@@ -28,8 +28,8 @@
 
 <listitem>
 	<para>
-	<emphasis>'branch'</emphasis> - this flag enables
-	searching through existing branches for aor's and expanding
+	<emphasis>'branch'</emphasis> - (old <emphasis>r</emphasis> flag) this flag
+	enables searching through existing branches for aor's and expanding
 	them to contacts. For example, you have got AOR A in your
 	ruri but you also want to forward your calls to AOR B. In order
 	to do this, you must put AOR B in a branch, and if this flag
@@ -48,37 +48,38 @@
 
 <listitem>
 	<para>
-	<emphasis>'method-filtering'</emphasis> - setting this flag
-	will enable contact filtering based on the supported methods
+	<emphasis>'method-filtering'</emphasis> - (old <emphasis>m</emphasis> flag)
+	setting this flag will enable contact filtering based on the supported methods
 	listed in the "Allow" header field during registration.
 	Contacts which did not present an "Allow" header field during
 	registration are assumed to support all standard SIP methods.
 	</para>
 </listitem>
 <listitem>
 	<para>
-	<emphasis>'ua-filtering=[val]'</emphasis> (User-Agent filtering) - this flag
-	enables regexp filtering by user-agent. It's useful with
-	enabled append_branches parameter. The value must use the format '/regexp/'.
+	<emphasis>'ua-filtering=[val]'</emphasis> (old <emphasis>u</emphasis> flag)
+	(User-Agent filtering) - this flag enables regexp filtering by user-agent.
+	It's useful with enabled append_branches parameter. The value must use the
+	format '/regexp/'.
 	</para>
 </listitem>
 <listitem>
 	<para>
-	<emphasis>'case-insensitive'</emphasis> - this flag
-	enables case insensitive filtering for the 'ua-filtering' flag.
+	<emphasis>'case-insensitive'</emphasis> (old <emphasis>i</emphasis> flag) -
+	this flag enables case insensitive filtering for the 'ua-filtering' flag.
 	</para>
 </listitem>
 <listitem>
 	<para>
-	<emphasis>'extended-regexp'</emphasis> - this flag
-	enables using of extended regexp format for the 'ua-filtering' flag.
+	<emphasis>'extended-regexp'</emphasis> - (old <emphasis>e</emphasis> flag)
+	this flag enables using of extended regexp format for the 'ua-filtering' flag.
 	</para>
 </listitem>
 <listitem>
 	<para>
-	<emphasis>'global'</emphasis>  (Global lookup) - this flag
-	is only relevant with federated user location clustering. If
-	set, the &reg_lookup_f; function will not only perform the classic
+	<emphasis>'global'</emphasis> (old <emphasis>g</emphasis> flag) (Global
+	lookup) - this flag is only relevant with federated user location clustering.
+	If set, the &reg_lookup_f; function will not only perform the classic
 	in-memory "search-AoR-and-push-branches" operation, but will
 	also perform a metadata lookup and append an additional branch
 	for each returned result. The "in-memory branches" correspond
@@ -108,15 +109,15 @@
 </listitem>
 <listitem>
 	<para>
-	<emphasis>'max-ping-latency=[int]'</emphasis> - maximally
-	accepted contact pinging latency (microseconds). Contacts of an
+	<emphasis>'max-ping-latency=[int]'</emphasis> - (old <emphasis>y</emphasis>
+	flag) maximally accepted contact pinging latency (microseconds). Contacts of an
 	AoR with a higher latency will be discarded during &reg_lookup_f;.
 	</para>
 </listitem>
 <listitem>
 	<para>
-	<emphasis>'sort-by-latency'</emphasis> - contacts
-	will be picked in ascending order of their last successful
+	<emphasis>'sort-by-latency'</emphasis> - (old <emphasis>Y</emphasis> flag)
+	contacts will be picked in ascending order of their last successful
 	pinging latency (fastest ping -> slowest ping). This flag may
 	work together with the "max-ping-latency" flag.
 	</para>

modules/registrar/doc/registrar_admin.xml

@@ -487,14 +487,16 @@ modparam("registrar", "disable_gruu", 0)
 			<itemizedlist>
 				&save_common_flags;
 				<listitem>
-					<para><emphasis>'socket-header'</emphasis> -
-					look into REGISTER request for a header which contains a socket
+					<para><emphasis>'socket-header'</emphasis> - (old
+					<emphasis>s</emphasis> flag) look into REGISTER request
+					for a header which contains a socket
 					description (proto:IP:port). This socket info will be
 					stored by register instead of the received socket info.
 					</para>
 				</listitem>
 				<listitem>
-					<para><emphasis>'min-expires=[int]'</emphasis> -  this
+					<para><emphasis>'min-expires=[int]'</emphasis> - (old
+					<emphasis>e</emphasis> flag) this
 					flag can be used to set minimum register expiration time.
 					Values lower than this minimum will be automatically set
 					to the minimum. Value 0 disables the checking.
@@ -503,7 +505,8 @@ modparam("registrar", "disable_gruu", 0)
 					</para>
 				</listitem>
 				<listitem>
-					<para><emphasis>'max-expires=[int]'</emphasis> -  this
+					<para><emphasis>'max-expires=[int]'</emphasis> - (old
+					<emphasis>E</emphasis> flag) this
 					flag can be used to set maximum register expiration time.
 					Values higher than this maximum will be automatically set
 					to the maximum. Value 0 disables the checking.