comparison xml/en/docs/http/ngx_http_stub_status_module.xml @ 1275:c9b202d6c426

Documented the new syntax of the "stub_status" directive.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 26 Aug 2014 17:37:03 +0400
parents 794717949a83
children dd190baef1e7
comparison
equal deleted inserted replaced
1274:794717949a83 1275:c9b202d6c426
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_stub_status_module" 10 <module name="Module ngx_http_stub_status_module"
11 link="/en/docs/http/ngx_http_stub_status_module.html" 11 link="/en/docs/http/ngx_http_stub_status_module.html"
12 lang="en" 12 lang="en"
13 rev="1"> 13 rev="2">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_stub_status_module</literal> module provides 18 The <literal>ngx_http_stub_status_module</literal> module provides
31 <section id="example" name="Example Configuration"> 31 <section id="example" name="Example Configuration">
32 32
33 <para> 33 <para>
34 <example> 34 <example>
35 location /basic_status { 35 location /basic_status {
36 stub_status on; 36 stub_status;
37 } 37 }
38 </example> 38 </example>
39 This configuration creates a simple web page 39 This configuration creates a simple web page
40 with basic status data which may look like as follows: 40 with basic status data which may look like as follows:
41 <example> 41 <example>
50 50
51 51
52 <section id="directives" name="Directives"> 52 <section id="directives" name="Directives">
53 53
54 <directive name="stub_status"> 54 <directive name="stub_status">
55 <syntax><literal>on</literal> | <literal>off</literal></syntax> 55 <syntax/>
56 <default>off</default> 56 <default/>
57 <context>server</context>
57 <context>location</context> 58 <context>location</context>
58 59
59 <para> 60 <para>
60 The basic status information will be accessible from the surrounding location. 61 The basic status information will be accessible from the surrounding location.
62 </para>
63
64 <para>
65 <note>
66 In versions prior to 1.7.5,
67 the directive required an arbitrary argument.
68 </note>
61 </para> 69 </para>
62 70
63 </directive> 71 </directive>
64 72
65 </section> 73 </section>