Browse code

xhttp Minor typo fixes in README

Olle E. Johansson authored on 02/01/2015 21:56:21
Showing 2 changed files
... ...
@@ -69,16 +69,17 @@ Chapter 1. Admin Guide
69 69
 
70 70
 1. Overview
71 71
 
72
-   This module provides basic HTTP/1.0 server functionality inside SIP
73
-   Router. SIP and HTTP are very similar protocols, so, practically, the
72
+   This module provides basic HTTP/1.0 server functionality inside
73
+   Kamailio. SIP and HTTP are very similar protocols, so, practically, the
74 74
    SIP parser can easily handle HTTP requests just by adding a fake Via
75 75
    header.
76 76
 
77
-   The xmlrpc module uses the same concept. xHTTP module offers a generic
78
-   HTTP handling way, by calling event_route[xhttp:request] in your
79
-   config. You can check the HTTP URL via config variable $hu. Note that
80
-   use of $ru will raise errors since the structure of an HTTP URL is not
81
-   compatible with that of a SIP URI.
77
+   The <module>xmlrpc</module> module uses the same concept. The xHTTP
78
+   module offers a generic way of handling the HTTP protocol, by calling
79
+   event_route[xhttp:request] in your config. You can check the HTTP URL
80
+   via the config variable $hu. Note that use of $ru will raise errors
81
+   since the structure of an HTTP URL is not compatible with that of a SIP
82
+   URI.
82 83
 
83 84
 2. Note on Latency
84 85
 
... ...
@@ -140,7 +141,7 @@ Chapter 1. Admin Guide
140 141
 
141 142
 4.1. url_skip (str)
142 143
 
143
-   Regular expression to match the HTTP URL. If there is a match, then
144
+   Regular expression to match the HTTP URL. If there is a match, the
144 145
    event route is not executed.
145 146
 
146 147
    Default value is null (don't skip).
... ...
@@ -152,7 +153,7 @@ modparam("xhttp", "url_skip", "^/RPC2")
152 153
 
153 154
 4.2. url_match (str)
154 155
 
155
-   Regular expression to match the HTTP URL. If there is no match, then
156
+   Regular expression to match the HTTP URL. If there is no match, the
156 157
    event route is not executed. This check is done after url_skip, so if
157 158
    both url_skip and url_match would match then the event route is not
158 159
    executed (url_skip has higher priority).
... ...
@@ -16,17 +16,19 @@
16 16
 	<section>
17 17
 	<title>Overview</title>
18 18
 	<para>
19
-		This module provides basic HTTP/1.0 server functionality inside SIP
20
-		Router. SIP and HTTP are very similar protocols, so, practically, the
19
+		This module provides basic HTTP/1.0 server functionality inside 
20
+		&kamailio;. SIP and HTTP are very similar protocols, so, practically, the
21 21
 		SIP parser can easily handle HTTP requests just by adding a fake
22 22
 		Via header.
23 23
 	</para>
24 24
 	<para>
25
-		The xmlrpc module uses the same concept. xHTTP module offers a
26
-		generic HTTP handling way, by calling event_route[xhttp:request]
27
-		in your config. You can check the HTTP URL via config variable
28
-		$hu. Note that use of $ru will raise errors since the structure 
29
-		of an HTTP URL is not compatible with that of a SIP URI.
25
+		The <module>xmlrpc</module> module uses the same concept.
26
+		The xHTTP module offers a generic way of handling the <acronym>HTTP</acronym>
27
+		protocol, by calling <emphasis>event_route[xhttp:request]</emphasis>
28
+		in your config. You can check the HTTP URL via the config variable
29
+		<acronym>$hu</acronym>. Note that use of <acronym>$ru</acronym> will
30
+		raise errors since the structure of an HTTP URL is not compatible with
31
+		that of a SIP URI.
30 32
 	</para>
31 33
 	</section>
32 34
 
... ...
@@ -54,7 +56,8 @@
54 56
 		SIP processing.  SIP worker threads will block, pending the outcome of the 
55 57
 		event route just like any other config script route.  
56 58
 	</para>
57
-	<para>  This is no more or less true for <emphasis>xhttp</emphasis> than it is for 
59
+	<para>
60
+		This is no more or less true for <emphasis>xhttp</emphasis> than it is for 
58 61
 		any other block of script in any other scenario, and does not warrant any 
59 62
 		extraordinary concern.  It nevertheless bears mention here because some 
60 63
 		processes with embedded HTTP servers have the request processing take place 
... ...
@@ -115,7 +118,7 @@
115 118
 		<title><varname>url_skip</varname> (str)</title>
116 119
 		<para>
117 120
 			Regular expression to match the HTTP URL. If there is a match,
118
-			then event route is not executed.
121
+			the event route is not executed.
119 122
 		</para>
120 123
 		<para>
121 124
 		<emphasis>
... ...
@@ -135,7 +138,7 @@ modparam("xhttp", "url_skip", "^/RPC2")
135 138
 		<title><varname>url_match</varname> (str)</title>
136 139
 		<para>
137 140
 			Regular expression to match the HTTP URL. If there is no match,
138
-			then event route is not executed. This check is done after
141
+			the event route is not executed. This check is done after
139 142
 			url_skip, so if both url_skip and url_match would match then
140 143
 			the event route is not executed (url_skip has higher priority).
141 144
 		</para>