changeset 148:682163f2b298

Unified article/path and module/pathname into a single "path". "path" no longer emits double quotes so preserve them where needed. Replaced some misuses of "path" and "dirname".
author Ruslan Ermilov <ru@nginx.com>
date Tue, 25 Oct 2011 13:28:36 +0000
parents 8057b7793bd9
children 19c36eed784e
files dtd/content.dtd dtd/module.dtd xml/en/docs/freebsd_tuning.xml xml/en/docs/http/configuring_https_servers.xml xml/en/docs/http/ngx_http_core_module.xml xml/en/docs/http/ngx_http_mp4_module.xml xml/en/docs/http/request_processing.xml xml/en/docs/windows.xml xml/en/download.xml xml/ru/docs/http/ngx_http_mp4_module.xml xsls/content.xsls
diffstat 11 files changed, 36 insertions(+), 41 deletions(-) [+]
line wrap: on
line diff
--- a/dtd/content.dtd	Tue Oct 25 12:45:29 2011 +0000
+++ b/dtd/content.dtd	Tue Oct 25 13:28:36 2011 +0000
@@ -9,7 +9,7 @@
                          i | b | nobr | table | url | code | command |
                          dirname | path | header | value | programlisting |
                          initial | development_version | stable_version |
-                         registered | pathname)* >
+                         registered)* >
 
 <!ELEMENT  a            (#PCDATA) >
 <!ATTLIST  a
@@ -30,7 +30,6 @@
 <!ELEMENT  command      (#PCDATA | value)* >
 <!ELEMENT  dirname      (#PCDATA | i)* >
 <!ELEMENT  path         (#PCDATA | development_version | stable_version)* >
-<!ELEMENT  pathname     (#PCDATA)* >
 <!ELEMENT  code         (#PCDATA | i)* >
 <!ELEMENT  header       (#PCDATA) >
 <!ELEMENT  initial      (#PCDATA) >
@@ -42,7 +41,7 @@
 <!ELEMENT  programlisting  (#PCDATA | i | b | dirname | path |
                             development_version | stable_version)* >
 
-<!ELEMENT  nobr         (#PCDATA | i | b | command | dirname | path)* >
+<!ELEMENT  nobr         (#PCDATA | i | b | code | command | dirname | path)* >
 
 <!ELEMENT  list         (item+ | listitem+) >
 <!ELEMENT  orderedlist  (item+) >
--- a/dtd/module.dtd	Tue Oct 25 12:45:29 2011 +0000
+++ b/dtd/module.dtd	Tue Oct 25 13:28:36 2011 +0000
@@ -29,7 +29,7 @@
 
 <!ELEMENT   para        (#PCDATA | argument | c-def | c-func | code | command |
                          emphasis | example | header | http-status | link |
-                         list | note | parameter | pathname | value | var)* >
+                         list | note | parameter | path | value | var)* >
 
 <!ELEMENT   argument    (#PCDATA)* >
 
@@ -73,7 +73,7 @@
 
 <!ELEMENT   parameter   (#PCDATA)* >
 
-<!ELEMENT   pathname    (#PCDATA)* >
+<!ELEMENT   path        (#PCDATA)* >
 
 <!ELEMENT   value       (#PCDATA)* >
 
--- a/xml/en/docs/freebsd_tuning.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/docs/freebsd_tuning.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -26,7 +26,7 @@
 After the connection has been established it is placed in the listen queue
 of the listen socket.
 To see the current listen queues state, you may run the command
-<path>netstat -Lan</path>:
+“<command>netstat -Lan</command>”:
 
 <programlisting>
 Current listen queue sizes (qlen/incqlen/maxqlen)
@@ -164,7 +164,7 @@
 while the mbuf clusters are used for both sending and receiving.
 
 To see the current usage of the mbufs and clusters and their limits,
-you may run the command <nobr><path>netstat -m</path>.</nobr>
+you may run the command <nobr>“<command>netstat -m</command>”.</nobr>
 Here is a sample from FreeBSD 7.2/amd64 with the default settings:
 
 <programlisting>
@@ -239,7 +239,7 @@
 
 <para>
 And again, the amd64 sendfile implementation is the best:
-the zeros in the <nobr><path>netstat -m</path></nobr> output
+the zeros in the <nobr>“<code>netstat -m</code>”</nobr> output
 <programlisting>
 ...
 <b>0/0/0</b> sfbufs in use (current/peak/max)
--- a/xml/en/docs/http/configuring_https_servers.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/docs/http/configuring_https_servers.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -161,7 +161,7 @@
 may already have the required intermediate certificates and
 may not complain about a certificate sent without a chained bundle.
 To ensure the server sends the complete certificate chain,
-you may use the <path>openssl</path> command line utility, for example:
+you may use the <command>openssl</command> command line utility, for example:
 
 <programlisting>
 $ openssl s_client -connect www.godaddy.com:443
--- a/xml/en/docs/http/ngx_http_core_module.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/docs/http/ngx_http_core_module.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -47,7 +47,7 @@
 Giant lock&mdash;for this to work, the AIO module needs to be loaded
 after the kernel has booted.
 In this case, the following message will appear in
-<pathname>/var/log/messages</pathname>
+<path>/var/log/messages</path>
 <example>
 WARNING: Network stack Giant-free, but aio requires Giant.
 Consider adding 'options NET_WITH_GIANT' or setting debug.mpsafenet=0
@@ -147,7 +147,7 @@
 the request of
 “<code>/i/top.gif</code>” will be responded
 with the file
-<pathname>/data/w3/images/top.gif</pathname>.
+<path>/data/w3/images/top.gif</path>.
 </para>
 
 <para>
@@ -1530,7 +1530,7 @@
 </example>
 “<code>/i/top.gif</code>” will be responded
 with the file
-<pathname>/data/w3/i/top.gif</pathname>.
+<path>/data/w3/i/top.gif</path>.
 </para>
 
 <para>
@@ -2039,7 +2039,7 @@
 
 <para>
 A sufficiently full mapping table is distributed with nginx in the
-<pathname>conf/mime.types</pathname> file.
+<path>conf/mime.types</path> file.
 </para>
 
 <para>
--- a/xml/en/docs/http/ngx_http_mp4_module.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/docs/http/ngx_http_mp4_module.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -11,8 +11,7 @@
 <para>
 The module <code>ngx_http_mp4_module</code> provides pseudo-streaming
 server-side support for H.264/AAC files typically having filename extensions
-<pathname>.mp4</pathname>, <pathname>.m4v</pathname>,
-and <pathname>.m4a</pathname>.
+<path>.mp4</path>, <path>.m4v</path>, and <path>.m4a</path>.
 </para>
 
 <para>
--- a/xml/en/docs/http/request_processing.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/docs/http/request_processing.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -201,7 +201,7 @@
 <para>
 nginx first searches for the most specific location given by literal strings
 regardless of the listed order. In the configuration above
-the only literal location is <path>/</path> and since it matches
+the only literal location is “<code>/</code>” and since it matches
 any request it will be used as a last resort.
 Then nginx checks locations given by
 regular expression in the order listed in the configuration file.
@@ -235,11 +235,11 @@
 
 <item>
 <para>
-A request <path>/logo.gif</path> is matched by the literal location
-<dirname>/</dirname> first and then by the regular expression
-<dirname>\.(gif|jpg|png)$</dirname>,
+A request “<code>/logo.gif</code>” is matched by the literal location
+“<code>/</code>” first and then by the regular expression
+“<code>\.(gif|jpg|png)$</code>”,
 therefore, it is handled by the latter location.
-Using the directive <dirname>root&nbsp;/data/www</dirname> the request
+Using the directive “<code>root&nbsp;/data/www</code>” the request
 is mapped to a file <path>/data/www/logo.gif</path>, and the file
 is sent to the client.
 </para>
@@ -247,25 +247,25 @@
 
 <item>
 <para>
-A request <path>/index.php</path> is also matched by the literal location
-<dirname>/</dirname> first and then by the regular expression
-<dirname>\.(php)$</dirname>. Therefore, it is handled by the latter location
+A request “<code>/index.php</code>” is also matched by the literal location
+“<code>/</code>” first and then by the regular expression
+“<code>\.(php)$</code>”. Therefore, it is handled by the latter location
 and the request is passed to a FastCGI server listening on localhost:9000.
 The <dirname>fastcgi_param</dirname> directive sets the FastCGI parameter
-SCRIPT_FILENAME to <path>/data/www/index.php</path>,
+SCRIPT_FILENAME to “<code>/data/www/index.php</code>”,
 and the FastCGI server executes the file.
 The variable $document_root is equal to
 the value of the <dirname>root</dirname> directive and
 the variable $fastcgi_script_name is equal to the request URI,
-i.e. <path>/index.php</path>.
+i.e. “<code>/index.php</code>”.
 </para>
 </item>
 
 <item>
 <para>
-A request <path>/about.html</path> is matched by the literal location
-<dirname>/</dirname> only, therefore, it is handled in this location.
-Using the directive <dirname>root /data/www</dirname> the request is mapped
+A request “<code>/about.html</code>” is matched by the literal location
+“<code>/</code>” only, therefore, it is handled in this location.
+Using the directive “<code>root /data/www</code>” the request is mapped
 to the file <path>/data/www/about.html</path>, and the file is sent
 to the client.
 </para>
@@ -273,14 +273,14 @@
 
 <item>
 <para>
-Handling a request <path>/</path> is more complex.
-It is matched by the literal location <dirname>/</dirname> only,
+Handling a request “<code>/</code>” is more complex.
+It is matched by the literal location “<code>/</code>” only,
 therefore, it is handled by this location.
 Then the <dirname>index</dirname> directive tests for the existence
 of an index file according to its parameters and
-the <dirname>root&nbsp;/data/www</dirname> directive.
+the “<code>root&nbsp;/data/www</code>” directive.
 If a file <path>/data/www/index.php</path> exists,
-then the directive does an internal redirect to <path>/index.php</path>, and
+then the directive does an internal redirect to “<code>/index.php</code>”, and
 nginx searches the locations again as if the request had been sent by a client.
 As we saw before, the redirected request will eventually be handled
 by the FastCGI server.
--- a/xml/en/docs/windows.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/docs/windows.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -34,7 +34,7 @@
 start nginx
 </programlisting>
 
-You may run the <path>tasklist</path> command line utility
+You may run the <command>tasklist</command> command line utility
 to see nginx processes:
 
 <programlisting>
--- a/xml/en/download.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/en/download.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -194,7 +194,7 @@
 </programlisting>
 
 As an alternative, a repository config can be added manually.
-Create the file named <pathname>/etc/yum.repos.d/nginx.repo</pathname>
+Create the file named <path>/etc/yum.repos.d/nginx.repo</path>
 with the following contents:
 
 <programlisting>
@@ -213,7 +213,7 @@
 
 <para>
 For Debian 6 append the following contents to
-<pathname>/etc/apt/sources.list</pathname>:
+<path>/etc/apt/sources.list</path>:
 
 <programlisting>
 deb http://nginx.org/packages/debian/ squeeze nginx
@@ -230,7 +230,7 @@
 
 <para>
 For Ubuntu 10.04 append the following contents to
-<pathname>/etc/apt/sources.list</pathname>:
+<path>/etc/apt/sources.list</path>:
 
 <programlisting>
 deb http://nginx.org/packages/ubuntu/ lucid nginx
--- a/xml/ru/docs/http/ngx_http_mp4_module.xml	Tue Oct 25 12:45:29 2011 +0000
+++ b/xml/ru/docs/http/ngx_http_mp4_module.xml	Tue Oct 25 13:28:36 2011 +0000
@@ -12,8 +12,7 @@
 Модуль <code>ngx_http_mp4_module</code> обеспечивает серверную поддержку
 псевдо-стриминга для файлов в формате H.264/AAC. Такие файлы обычно
 имеют расширения
-<pathname>.mp4</pathname>, <pathname>.m4v</pathname>
-и <pathname>.m4a</pathname>.
+<path>.mp4</path>, <path>.m4v</path> и <path>.m4a</path>.
 </para>
 
 <para>
--- a/xsls/content.xsls	Tue Oct 25 12:45:29 2011 +0000
+++ b/xsls/content.xsls	Tue Oct 25 13:28:36 2011 +0000
@@ -116,8 +116,6 @@
         X:text disable-output-escaping="yes" {&lt;p&gt; }
     }
 
-    X:template = "pathname" { <code> !!; </code> }
-
     X:template = "argument" { <code><i> !!; </i></code> }
     X:template = "parameter" { <code> !!; </code> }
 
@@ -151,7 +149,7 @@
 
     X:template = "var" { <code> !!; </code> }
 
-    X:template = "path" { X:text {&#8220;} <code> !!; </code> X:text {&#8221;} }
+    X:template = "path" { <code> !!; </code> }
     X:template = "code" { <code> !!; </code> }
     X:template = "i" { <i> !!; </i> }
     X:template = "b" { <b> !!; </b> }