Browse code

registrar: Update documentation

- Replace all occurences of "HF" with "header field"
- Replace all occurences of "HFs" with "header fields"

(cherry picked from commit d936c6276b6d8e45efd87a4fc25a55b9c3ab1fce)

whosgonna authored on 15/09/2020 15:29:08 • Henning Westerholt committed on 15/09/2020 15:50:15
Showing 1 changed files
... ...
@@ -28,7 +28,7 @@
28 28
 		If path support is enabled in the registrar module, a call to save(...)
29 29
 		stores the values of the Path Header(s) along with the contact into usrloc. 
30 30
 		There are three modes regarding the reply to a REGISTER including
31
-		one or more Path HFs:
31
+		one or more Path header fields:
32 32
 		</para>
33 33
 		<itemizedlist>
34 34
 			<listitem>
... ...
@@ -42,7 +42,7 @@
42 42
 			<para>
43 43
 				<emphasis>lazy</emphasis> - stores the Path header and 
44 44
 				passes it back to the UAC if Path-support is indicated 
45
-				by the <quote>path</quote> param in the Supported HF.
45
+				by the <quote>path</quote> param in the Supported header field.
46 46
 			</para>
47 47
 			</listitem>
48 48
 			<listitem>
... ...
@@ -56,8 +56,8 @@
56 56
 		</itemizedlist>
57 57
 		<para>
58 58
 		A call to lookup(...) always uses the path header if
59
-		found, and inserts it as Route HF either in front of
60
-		the first Route HF, or after the last Via HF if no
59
+		found, and inserts it as Route header field either in front of
60
+		the first Route header field, or after the last Via header field if no
61 61
 		Route is present. It also sets the destination uri to
62 62
 		the first Path uri, thus overwriting the received-uri,
63 63
 		because NAT has to be handled at the outbound-proxy of
... ...
@@ -131,7 +131,7 @@
131 131
 		<title><varname>default_expires</varname> (integer)</title>
132 132
 		<para>
133 133
 		If the processed message contains neither Expires 
134
-		<acronym>HFs</acronym> nor expires contact parameters, this value 
134
+		header fields nor expires contact parameters, this value 
135 135
 		will be used for newly created usrloc records. The parameter contains 
136 136
 		number of second to expire (for example use 3600 for one hour). If it
137 137
 		is set to a lower value than the <quote>min_expires</quote> parameter
... ...
@@ -1003,7 +1003,7 @@ end
1003 1003
 		</title>
1004 1004
 		<para>
1005 1005
 		The function processes a <emphasis>REGISTER</emphasis> message. It can add, remove or 
1006
-		modify location records (in usrloc) depending on Contact and Expires HFs in the 
1006
+		modify location records (in usrloc) depending on Contact and Expires header fields in the 
1007 1007
 		REGISTER message. On success and when called from the REQUEST_ROUTE, 
1008 1008
 		<quote>200 OK</quote> will be returned listing all contacts that are currently in 
1009 1009
 		the location database. On an error, an error message will be sent with a short