Permalink
Browse files

updated docs for v0.10.

  • Loading branch information...
1 parent aaf5fce commit ae532d8d9fbd950cd2a422f3cef0027c6fde6cd8 @agentzh agentzh committed Jun 6, 2010
Showing with 30 additions and 17 deletions.
  1. +16 −11 README
  2. +14 −6 doc/readme.wiki
View
27 README
@@ -6,9 +6,9 @@ Name
installation instructions.
Version
- This document describes headers-more-nginx-module v0.09
- (<http://github.com/agentzh/headers-more-nginx-module/tarball/v0.09 >)
- released on June 2, 2010.
+ This document describes headers-more-nginx-module v0.10
+ (<http://github.com/agentzh/headers-more-nginx-module/tarball/v0.10 >)
+ released on June 6, 2010.
Synopsis
# set the Server output header
@@ -264,6 +264,10 @@ Source Repository
(<http://github.com/agentzh/headers-more-nginx-module >).
ChangeLog
+ v0.10
+ * now we can remove an input and output header *completely*, including
+ both custom and builtin headers.
+
v0.09
* fixed a memory initialization issue for more_set_input_headers
without the "-r" option, we should always initialize "hv.replace"
@@ -295,23 +299,24 @@ Test Suite
(<http://github.com/agentzh/headers-more-nginx-module/tree/master/test/t
/>) are declarative
(<http://github.com/agentzh/headers-more-nginx-module/blob/master/test/t
- /sanity.t>) too. Thanks to the Test::Base
- (<http://search.cpan.org/perldoc?Test::Base >) module in the Perl world.
+ /sanity.t>) too. Thanks to the Test::Nginx
+ (<http://search.cpan.org/perldoc?Test::Nginx >) module in the Perl world.
To run it on your side:
$ cd test
$ PATH=/path/to/your/nginx-with-headers-more-module:$PATH prove -r t
+ To run the test suite with valgrind's memcheck, use the following
+ commands:
+
+ $ cd test
+ $ export PATH=/path/to/your/nginx-with-headers-more-module:$PATH
+ $ TEST_NGINX_USE_VALGRIND=1 prove -r t
+
You need to terminate any Nginx processes before running the test suite
if you have changed the Nginx server binary.
- At the moment, LWP::UserAgent
- (<http://search.cpan.org/perldoc?LWP::UserAgent >) is used by the test
- scaffold
- (<http://github.com/agentzh/headers-more-nginx-module/blob/master/test/l
- ib/Test/Nginx/LWP.pm>) for simplicity.
-
Because a single nginx server (by default, "localhost:1984") is used
across all the test scripts (".t" files), it's meaningless to run the
test suite in parallel by specifying "-jN" when invoking the "prove"
View
@@ -6,7 +6,7 @@
= Version =
-This document describes headers-more-nginx-module [http://github.com/agentzh/headers-more-nginx-module/tarball/v0.09 v0.09] released on June 2, 2010.
+This document describes headers-more-nginx-module [http://github.com/agentzh/headers-more-nginx-module/tarball/v0.10 v0.10] released on June 6, 2010.
= Synopsis =
@@ -267,6 +267,9 @@ Available on github at [http://github.com/agentzh/headers-more-nginx-module agen
= ChangeLog =
+== v0.10 ==
+* now we can remove an input and output header ''completely'', including both custom and builtin headers.
+
== v0.09 ==
* fixed a memory initialization issue for [[#more_set_input_headers|more_set_input_headers]] without the <code>-r</code> option, we should always initialize <code>hv.replace</code> even when replace == 0. This may result in server segfaults and was introduced in [[#v0.08|v0.08]].
* implemented wildcard support in [[#more_clear_headers|more_clear_headers]]. Thanks Bernd Dorn.
@@ -286,7 +289,7 @@ Available on github at [http://github.com/agentzh/headers-more-nginx-module agen
= Test Suite =
This module comes with a Perl-driven test suite. The [http://github.com/agentzh/headers-more-nginx-module/tree/master/test/t/ test cases] are
-[http://github.com/agentzh/headers-more-nginx-module/blob/master/test/t/sanity.t declarative] too. Thanks to the [http://search.cpan.org/perldoc?Test::Base Test::Base] module in the Perl world.
+[http://github.com/agentzh/headers-more-nginx-module/blob/master/test/t/sanity.t declarative] too. Thanks to the [http://search.cpan.org/perldoc?Test::Nginx Test::Nginx] module in the Perl world.
To run it on your side:
@@ -295,16 +298,21 @@ To run it on your side:
$ PATH=/path/to/your/nginx-with-headers-more-module:$PATH prove -r t
</geshi>
-You need to terminate any Nginx processes before running the test suite if you have changed the Nginx server binary.
+To run the test suite with valgrind's memcheck, use the following commands:
+
+<geshi lang="bash">
+ $ cd test
+ $ export PATH=/path/to/your/nginx-with-headers-more-module:$PATH
+ $ TEST_NGINX_USE_VALGRIND=1 prove -r t
+</geshi>
+
-At the moment, [http://search.cpan.org/perldoc?LWP::UserAgent LWP::UserAgent] is used by the [http://github.com/agentzh/headers-more-nginx-module/blob/master/test/lib/Test/Nginx/LWP.pm test scaffold] for simplicity.
+You need to terminate any Nginx processes before running the test suite if you have changed the Nginx server binary.
Because a single nginx server (by default, <code>localhost:1984</code>) is used across all the test scripts (<code>.t</code> files), it's meaningless to run the test suite in parallel by specifying <code>-jN</code> when invoking the <code>prove</code> utility.
Some parts of the test suite requires modules [[NginxHttpProxyModule|proxy]], [[NginxHttpRewriteModule|rewrite]], and [[NginxHttpEchoModule|echo]] to be enabled as well when building Nginx.
-
-
= TODO =
* Support variables in new headers' keys.

0 comments on commit ae532d8

Please sign in to comment.