cvs commit: modperl-docs TODO
stas2002/06/15 11:51:10 Modified:.TODO Log: this is actually not a bug Revision ChangesPath 1.61 +0 -4 modperl-docs/TODO Index: TODO === RCS file: /home/cvs/modperl-docs/TODO,v retrieving revision 1.60 retrieving revision 1.61 diff -u -r1.60 -r1.61 --- TODO 15 Jun 2002 18:24:09 - 1.60 +++ TODO 15 Jun 2002 18:51:10 - 1.61 @@ -15,10 +15,6 @@ DocSet: --- -- CacheNavigator has an edge case bug with hidden chapters. If there - are only hidden elements, it'll return the first hidden element - instead of undef. - - need to be able to copy elements from the section of the source html into the target file. Since this may cause collisions with preset headers, need to override the preset header's elements - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/download binaries.pod
stas2002/06/15 11:27:01 Modified:src/download binaries.pod Log: missing period Revision ChangesPath 1.9 +1 -1 modperl-docs/src/download/binaries.pod Index: binaries.pod === RCS file: /home/cvs/modperl-docs/src/download/binaries.pod,v retrieving revision 1.8 retrieving revision 1.9 diff -u -r1.8 -r1.9 --- binaries.pod 11 Jun 2002 20:24:03 - 1.8 +++ binaries.pod 15 Jun 2002 18:27:01 - 1.9 @@ -23,7 +23,7 @@ and some common modules, so are largish. For more information please read the L +Documentation|docs::1.0::os::index>. =head2 Win32 mod_perl 2.x (BETA) - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/user/handlers handlers.pod
stas2002/06/15 11:26:33 Added: src/docs/2.0/user/handlers handlers.pod Log: starting the handlers doc Revision ChangesPath 1.1 modperl-docs/src/docs/2.0/user/handlers/handlers.pod Index: handlers.pod === =head1 NAME Using Perl*Handlers =head1 Description This chapter discusses Cs and presents examples of their use. META: need to add/correct a diagram similar to the one in the eagle book, presenting the order of the phases. | v -->[wait]>post-read-request | | | v |URI translation | | | v | header parsing | | | v | access control || cleanup v | authentication | | | v | authorization | | | v |MIME type checking | | | v logging <- RESPONSE <-- fixups =head1 Handlers (Hooks) Types For each phase there can be more than one handler assigned (also known as I, because the C functions are called Iphase_nameE>). The following types specify a phase's behavior when there is more then one handler to run for this phase. (For C API declarations see I, which includes other types which aren't exposed by mod_perl.) =over =item * VOID Handlers of the type C will be I executed in the order they have been registered disregarding their return values. Though in mod_perl they are expected to return C. =item * RUN_FIRST Handlers of the type C will be executed in the order they have been registered until the first handler that returns something other than C. If the return value is C, the next handler in the chain will be run. If the return value is C the next phase will start. In all other cases the execution will be aborted. =item * RUN_ALL Handlers of the type C will be executed in the order they have been registered until the first handler that returns something other than C or C. =back Also see L =head1 Hook Ordering (Position) The following constants specify how the new hooks (handlers) are inserted into the list of hooks when there is at least one hook already registered for the same phase. META: need to verify the following: =over =item * C run this hook first, before ANYTHING. =item * C run this hook first. =item * C run this hook somewhere. =item * C run this hook after every other hook which is defined. =item * C run this hook last, after EVERYTHING. =back META: more information in mod_example.c talking about position/predecessors, etc. =head1 Server Configuration (Startup) Phases =head2 PerlOpenLogsHandler The I phase happens just before the I phase. Handlers registered by C are usually used for opening module-specific log files. At this stage the C stream is not yet redirected to I, and therefore any messages to that stream will be printed to the console the server is starting from (if such exists). This phase is of type C. The handler's configuration scope is C. Example: =head2 PerlPostConfigHandler The I phase happens right after Apache has processed the configuration files, before any child processes were spawned (which happens at the I phase). This phase can be used for initializing things to be shared between all child processes. You can do the same in the startup file, but in the I phase you have an access to a complete configuration tree. This phase is of type C. The handler's configuration scope is C. Example: =head2 PerlChildInitHandler The I phase happens immediately after the child process is spawned. Each child process will run the hooks of this phase only once in their life-time. In the prefork MPM this phase is useful for pre-opening database connections (similar to Apache::DBI in mod_perl 1.0). This phase is of type C. The handler's configuration scope is C. Example: =head1 Command (Protocol) Phases META: blurb =head2 PerlPreConnectionHandler The I phase h
cvs commit: modperl-docs/src/docs/2.0/user/handlers - New directory
stas2002/06/15 11:26:12 modperl-docs/src/docs/2.0/user/handlers - New directory - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/docs/2.0/user/config config.pod
stas2002/06/15 11:25:58 Modified:src/docs/2.0/user/config config.pod Log: work in progress on configuration issues Revision ChangesPath 1.16 +203 -11 modperl-docs/src/docs/2.0/user/config/config.pod Index: config.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/user/config/config.pod,v retrieving revision 1.15 retrieving revision 1.16 diff -u -r1.15 -r1.16 --- config.pod4 Jun 2002 10:11:42 - 1.15 +++ config.pod15 Jun 2002 18:25:58 - 1.16 @@ -2,10 +2,18 @@ mod_perl 2.0 Server Configuration + + =head1 Description This chapter provides an indepth mod_perl 2.0 configuration details. + + + + + + =head1 mod_perl configuration directives Similar to mod_perl 1.0, in order to use mod_perl 2.0 a few @@ -13,6 +21,14 @@ quite similar to 1.0 settings but some directives were renamed and new directives were added. + + + + + + + + =head1 Enabling mod_perl To enable mod_perl built as DSO add to I: @@ -27,6 +43,11 @@ + + + + + =head1 Perl's Command Line Switches Now you can pass any Perl's command line switches in I @@ -46,6 +67,13 @@ whereas C<-I> does not. + + + + + + + =head1 PerlOptions Directive The directive C provides fine-grained configuration for @@ -131,8 +159,13 @@ =head2 C -Disable C, all compiled in handlers are enabled by -default. +Disable Cs, all compiled-in handlers are enabled by +default. The option name is derived from the C name, by +stripping the C and C parts of the word. So +C becomes C which can be used to disable +C: + + PerlOptions -Log Suppose one of the hosts does not want to allow users to configure C, C, C and @@ -308,6 +341,14 @@ Notice that we have got the value of the environment variable I. + + + + + + + + =head1 Handlers Directives META: need to add descriptions @@ -375,6 +416,8 @@ + + =head1 Threads Mode Specific Directives These directives are enabled only in a threaded mod_perl+Apache combo: @@ -454,7 +497,145 @@ -=head1 Server Startup Define Option Retrieval + + + + + + +=head1 mod_perl Directives Argument Types and Allowed Location + +The following table shows where in the configuration files mod_perl +configuration directives are allowed to appear, what kind of and how +many arguments they expect: + +General directives: + +Directive Arguments SRV DIR + --- + PerlSwitches ITERATE V + PerlRequire ITERATE V + PerlModule ITERATE V + PerlOptions ITERATE V V + PerlSetVar TAKE2 V V + PerlAddVar ITERATE2 V V + PerlSetEnv TAKE2 V V + PerlPassEnv TAKE1 V + Sections RAW_ARGS V + PerlTraceTAKE1 V + +Handler assignment directives: + +Directive Arguments TYPE SRV DIR + - + PerlOpenLogsHandler ITERATE RUN_ALLV + PerlPostConfigHandlerITERATE RUN_ALLV + PerlChildInitHandler ITERATE VOID V + + PerlPreConnectionHandler ITERATE RUN_ALLV + PerlProcessConnectionHandler ITERATE RUN_FIRST V + + PerlPostReadRequestHandler ITERATE RUN_ALLV + PerlTransHandler ITERATE RUN_FIRST V + PerlInitHandler ITERATE RUN_ALLV V + PerlHeaderParserHandler ITERATE RUN_ALLV V + PerlAccessHandlerITERATE RUN_ALLV V + PerlAuthenHandlerITERATE RUN_FIRST V V + PerlAuthzHandler ITERATE RUN_FIRST V V + PerlTypeHandler ITERATE RUN_FIRST V V + PerlFixupHandler ITERATE RUN_ALLV V + PerlResponseHandler ITERATE RUN_FIRST V V + PerlLogHandler ITERATE RUN_ALLV V + PerlCleanupHandler ITERATE XXXV V + + PerlInputFilterHandler ITERATE VOID V V + PerlOutputFilterHandler ITERATE VOID V V + + +Perl Interpreter management directives: + +Directive Arguments SRV DIR + --- + PerlInterpStart TAKE1 V + PerlInterpMaxTAKE1 V + PerlInterpMinSpare TAKE1 V + PerlInterpMaxSpare TAKE1 V + PerlInterp
cvs commit: modperl-docs/src/docs/2.0/api/mod_perl-2.0/Apache Reload.pod
stas2002/06/15 11:24:58 Modified:src/docs/2.0/api/mod_perl-2.0/Apache Reload.pod Log: use =head1 for non-synopsis things Revision ChangesPath 1.7 +4 -4 modperl-docs/src/docs/2.0/api/mod_perl-2.0/Apache/Reload.pod Index: Reload.pod === RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/mod_perl-2.0/Apache/Reload.pod,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- Reload.pod1 Jun 2002 08:53:43 - 1.6 +++ Reload.pod15 Jun 2002 18:24:58 - 1.7 @@ -116,7 +116,7 @@ magically reloaded on the next request. This option works with any mode described before. -=head2 Performance Issues +=head1 Performance Issues This modules is perfectly suited for a development environment. Though it's possible that you would like to use it in a production @@ -145,14 +145,14 @@ Therefore doing a full server stop and restart is probably a better solution. -=head2 Debug +=head1 Debug If you aren't sure whether the modules that are supposed to be reloaded, are actually getting reloaded, turn the debug mode on: PerlSetVar ReloadDebug On -=head2 Threaded MPM and Multiple Perl Interpreters +=head1 Threaded MPM and Multiple Perl Interpreters If you use C with a threaded MPM and multiple Perl interpreters, the modules will be reloaded by each interpreter as they @@ -168,7 +168,7 @@ reloaded subroutines. -=head2 Pseudo-hashes +=head1 Pseudo-hashes The short summary of this is: Don't use pseudo-hashes. They are deprecated since Perl 5.8 and will be removed in 5.10 - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs TODO
stas2002/06/15 11:24:09 Modified:.TODO Log: update TODO issues Revision ChangesPath 1.60 +16 -9 modperl-docs/TODO Index: TODO === RCS file: /home/cvs/modperl-docs/TODO,v retrieving revision 1.59 retrieving revision 1.60 diff -u -r1.59 -r1.60 --- TODO 11 Jun 2002 20:14:48 - 1.59 +++ TODO 15 Jun 2002 18:24:09 - 1.60 @@ -15,6 +15,10 @@ DocSet: --- +- CacheNavigator has an edge case bug with hidden chapters. If there + are only hidden elements, it'll return the first hidden element + instead of undef. + - need to be able to copy elements from the section of the source html into the target file. Since this may cause collisions with preset headers, need to override the preset header's elements @@ -50,6 +54,8 @@ General: +- need to remove the old 1.0 win32 stuff + - Need to document the font-type and -size used for the image button, so in the future we can add new buttons of the same style if needed. STATUS: waiting for input from Allan @@ -57,13 +63,6 @@ Content: -- need to fix 404.html to include: - - http://perl.apache.org/";> - - STATUS: DocSet needs to support copying of other than - headers first. - - ask perl.com to link to perl.apache.org from 'perl sites' section. + also they need to add theperlreview.com @@ -71,6 +70,12 @@ - Replace occurences of 1.x and 2.x with 1.0 and 2.0 +- src/products/apache-modlist.html can be removed after Doug's + blessing + STATUS: Per Einar thinks that some of the material could be re-used + before deleting the file + + Search: --- - consider adding auto-focus feature: @@ -128,7 +133,9 @@ Site Migration process: -- check that 404.html actually works. +- 404.html: + s|http://perl.apache.org/release/|http://perl.apache.org/| + check that 404.html actually works. - move the embperl cvs, as is and make sure that it's copied over as is without processing @@ -137,7 +144,7 @@ o move the /dist/ stuff, or symlink to it. o remove all the pods from /dist/ - o apache-modlist.html has moved (.htaccess already redirects it) + o remove apache-modlist.html - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src 404.html
stas2002/06/15 11:23:55 Modified:src 404.html Log: use the tag now that the headers are reproduced Revision ChangesPath 1.2 +1 -0 modperl-docs/src/404.html Index: 404.html === RCS file: /home/cvs/modperl-docs/src/404.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- 404.html 5 Jan 2002 19:21:48 - 1.1 +++ 404.html 15 Jun 2002 18:23:55 - 1.2 @@ -1,6 +1,7 @@ File not found! +http://perl.apache.org/release/";> - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/lib/DocSet/Source HTML.pm
stas2002/06/15 11:20:33
Modified:lib/DocSet RunTime.pm
lib/DocSet/Doc HTML2HTML.pm POD2HTML.pm
lib/DocSet/Source HTML.pm
Log:
sync with DocSet
- improve the parsing of the EheadE and make base, meta and
link elements available to the templates. [Per Einar Ellefsen
<[EMAIL PROTECTED]>]
- correct the mapping of config.cfg to autogenerated index.html, also
use path2uri to convert from a path to uri. also fix the stripping
of the full base path on the non unix system, by using abs2rel from
File::Spec.
Revision ChangesPath
1.8 +13 -23modperl-docs/lib/DocSet/RunTime.pm
Index: RunTime.pm
===
RCS file: /home/cvs/modperl-docs/lib/DocSet/RunTime.pm,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- RunTime.pm11 Jun 2002 15:02:10 - 1.7
+++ RunTime.pm15 Jun 2002 18:20:33 - 1.8
@@ -6,7 +6,7 @@
use strict;
use warnings;
-use File::Spec::Functions qw(catdir catfile splitdir);
+use File::Spec::Functions qw(catdir catfile splitdir abs2rel);
use File::Find;
use DocSet::Util;
@@ -84,7 +84,8 @@
@search_paths = @{$ra_search_paths || []};
-%exts = map {$_ => 1} @{$ra_search_exts || []};
+# .cfg is for matching config.cfg to become index.html
+%exts = map {$_ => 1} @{$ra_search_exts || []}, 'cfg';
my @ext_accept_pattern = map {quotemeta($_)."\$"} keys %exts;
my $rsub_keep_ext =
@@ -92,34 +93,23 @@
my %seen;
for my $rel_path (@search_paths) {
-my $full_path = catdir $base, $rel_path;
-die "$full_path is not a dir" unless -d $full_path;
+my $full_base_path = catdir $base, $rel_path;
+die "$full_base_path is not a dir" unless -d $full_base_path;
my @seen_pattern = map {"^".quotemeta($_)} keys %seen;
-my $rsub_skip_seen =
-build_matchmany_sub([EMAIL PROTECTED]);
+my $rsub_skip_seen = build_matchmany_sub([EMAIL PROTECTED]);
-# rewrite non / paths to be / as in URI ($rel_path is no more
-# needed to read from the real fs, will need this fixup for
-# generating proper URIs.
-$rel_path = join "/", splitdir $rel_path;
-
-my $full_path_regex = quotemeta $full_path;
-$src_docs{$rel_path} = {
-"index.html" => 1, # base index.html
-map { m{(.*?/?)[^/]+$} # add autogenerated index.html
- ? ("$1index.html" => 1, $_ => 1)
- : ($_ => 1); # shouldn't happen, but just in
case
-}
-map {join "/", splitdir $_} # rewrite non / paths to be
URI's /
-map {s|$full_path_regex/||; $_} # strip the leading path
+my $rel_uri = path2uri($rel_path);
+$src_docs{$rel_uri} = {
+map { s/config\.cfg$/index.html/; ($_ => 1) } # autogenerated
index.html
+map path2uri( abs2rel($_, $full_base_path) ), # full
path=>relative uri
grep $rsub_keep_ext->($_), # get files with wanted exts
grep !$rsub_skip_seen->($_),# skip seen base dirs
-@{ expand_dir($full_path) }
+@{ expand_dir($full_base_path) }
};
-note "Scanning for src files: $full_path";
-$seen{$full_path}++;
+note "Scanning for src files: $full_base_path";
+$seen{$full_base_path}++;
}
# dumper \%src_docs;
1.3 +1 -0 modperl-docs/lib/DocSet/Doc/HTML2HTML.pm
Index: HTML2HTML.pm
===
RCS file: /home/cvs/modperl-docs/lib/DocSet/Doc/HTML2HTML.pm,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- HTML2HTML.pm 5 Feb 2002 10:27:19 - 1.2
+++ HTML2HTML.pm 15 Jun 2002 18:20:33 - 1.3
@@ -20,6 +20,7 @@
my $vars = {
meta => $self->{meta},
body => [EMAIL PROTECTED],
+headers => $self->{parsed_tree}{head},
dir => $self->{dir},
nav => $self->{nav},
last_modified => $self->{timestamp},
1.7 +1 -0 modperl-docs/lib/DocSet/Doc/POD2HTML.pm
Index: POD2HTML.pm
===
RCS file: /home/cvs/modperl-docs/lib/DocSet/Doc/POD2HTML.pm,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- POD2HTML.pm 13 Jun 2002 09:20:16 - 1.6
+++ POD2HTML.pm 15 Jun 2002 18:20:33 - 1.7
@@ -48,6 +48,7 @@
meta => $self->{meta},
toc => $self->{toc},
body => [EMAIL PROTECTED],
cvs commit: modperl-docs/src/download index_top.html
pereinar2002/06/15 07:14:58 Modified:src/download index_top.html Log: Added some more info concerning the downloads (emphasize that 1.99 is really 2.0 in devel. Revision ChangesPath 1.2 +3 -3 modperl-docs/src/download/index_top.html Index: index_top.html === RCS file: /home/cvs/modperl-docs/src/download/index_top.html,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- index_top.html11 Jun 2002 05:58:47 - 1.1 +++ index_top.html15 Jun 2002 14:14:58 - 1.2 @@ -4,10 +4,10 @@ -Released Versions: +Current releases: -http://perl.apache.org/dist/";>mod_perl 1.27 (June 1, 2002) -http://perl.apache.org/dist/";>mod_perl 1.99_02 (beta) (June 1, 2002) +mod_perl 1.0: http://perl.apache.org/dist/";>1.27 (June 1, 2002) +mod_perl 2.0 (in development): http://perl.apache.org/dist/";>1.99_02 (beta) (June 1, 2002) - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
cvs commit: modperl-docs/src/contribute/docs .cvsignore config.cfg
pereinar2002/06/15 07:12:13
Modified:src/contribute config.cfg
Added: src/contribute/docs .cvsignore config.cfg
Log:
Making contribute/docs a DocSet, thereby avoiding the long list of links on
the contribute page.
Revision ChangesPath
1.5 +3 -24 modperl-docs/src/contribute/config.cfg
Index: config.cfg
===
RCS file: /home/cvs/modperl-docs/src/contribute/config.cfg,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- config.cfg10 Jun 2002 21:35:26 - 1.4
+++ config.cfg15 Jun 2002 14:12:13 - 1.5
@@ -25,26 +25,10 @@
},
],
- chapters => [qw(
- docs/style.pod
- docs/changes_file.pod
- docs/maintenance.pod
+ docsets => [qw(
+ docs
)],
- links => [
- {
- id => 'doc_template',
- link => 'docs/doc_template.pod',
- title => 'Document Template',
- abstract => 'When creating new documents, use this template.'
- },
- {
- id => 'changes_template',
- link => 'docs/Changes_template.pod',
- title => 'Changes Template',
- abstract => 'Example document for the Changes file'
- },
- ],
-
+
group => 'Contribute by Sharing Code',
chapters => [qw(
share_code.pod
@@ -60,11 +44,6 @@
},
],
- copy_glob => [qw(
- docs/doc_template.pod
- docs/Changes_template.pod
- )],
-
);
1;
1.1 modperl-docs/src/contribute/docs/.cvsignore
Index: .cvsignore
===
cache.*.dat
1.1 modperl-docs/src/contribute/docs/config.cfg
Index: config.cfg
===
use vars qw(@c);
@c = (
id => 'contribute_docs',
title => "How to Contribute to the Documentation",
abstract => "How to contribute to the mod_perl documentation:
style, tools, etc.",
chapters => [qw(
style.pod
changes_file.pod
maintenance.pod
)],
links => [
{
id => 'doc_template',
link => 'doc_template.pod',
title => 'Document Template',
abstract => 'When creating new documents, use this template.'
},
{
id => 'changes_template',
link => 'Changes_template.pod',
title => 'Changes Template',
abstract => 'Example document for the Changes file'
},
],
copy_glob => [qw(
doc_template.pod
Changes_template.pod
)],
);
1;
-
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
