stas 02/05/28 22:03:41
Modified: src/docs/general Changes.pod config.cfg correct_headers.pod
cvs_howto.pod
Log:
* cvs_howto:
o Changed incorrect repository names. Added some more references for
some of them (mod_perl 2 and mod_perl docs) relative to their
installation. Added note about ViewCVS. [Per Einar]
* correct headers.pod
o Some minor syntactic changes (moved SYNOPSIS to description ...)
[Per Einar]
* Made several groups within this docset to preserve clarity. [Per
Einar]
Submitted by: per einar
Revision Changes Path
1.6 +12 -0 modperl-docs/src/docs/general/Changes.pod
Index: Changes.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/general/Changes.pod,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- Changes.pod 13 May 2002 04:47:25 -0000 1.5
+++ Changes.pod 29 May 2002 05:03:41 -0000 1.6
@@ -11,6 +11,12 @@
=head1 ???
+* cvs_howto:
+
+ o Changed incorrect repository names. Added some more references for
+ some of them (mod_perl 2 and mod_perl docs) relative to their
+ installation. Added a note about ViewCVS. [Per Einar]
+
* perf_reference:
o added a section on overriding functions to trace their failure.
@@ -24,6 +30,9 @@
o rewrite the headers of this chapter [Per Einar Ellefsen]
+ o Some minor syntactic changes (moved SYNOPSIS to description ...)
+ [Per Einar]
+
* multiuser.pod
o chroot(1) info
@@ -31,5 +40,8 @@
o jail(8) info (Andrew McNaughton)
* started the general documents docset [Thomas Klausner]
+
+ o Made several groups within this docset to preserve clarity. [Per
+ Einar]
=cut
1.4 +19 -2 modperl-docs/src/docs/general/config.cfg
Index: config.cfg
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/general/config.cfg,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- config.cfg 11 May 2002 11:36:17 -0000 1.3
+++ config.cfg 29 May 2002 05:03:41 -0000 1.4
@@ -8,17 +8,34 @@
abstract => <<EOB,
Here you can find documentation concerning mod_perl in general,
but also not strictly mod_perl related information that is still
-very usefull for working with mod_perl.
+very useful for working with mod_perl.
EOB
+ group => 'Perl',
chapters => [qw(
perl_reference.pod
+ )],
+
+ group => 'HTTP',
+ chapters => [qw(
+ correct_headers.pod
+ )],
+
+ group => 'Server Administration',
+ chapters => [qw(
multiuser.pod
hardware.pod
control.pod
- correct_headers.pod
+ )],
+
+ group => 'mod_perl Advocacy',
+ chapters => [qw(
advocacy.pod
perl_myth.pod
+ )],
+
+ group => 'Miscellaneous',
+ chapters => [qw(
cvs_howto.pod
Changes.pod
)],
1.3 +7 -8 modperl-docs/src/docs/general/correct_headers.pod
Index: correct_headers.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/general/correct_headers.pod,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- correct_headers.pod 11 May 2002 11:54:45 -0000 1.2
+++ correct_headers.pod 29 May 2002 05:03:41 -0000 1.3
@@ -9,21 +9,20 @@
a vital importance. This document explains which headers you need to
pay attention to, and how to work with them.
-=head1 SYNOPSIS
-
As there is always more than one way to do it, I'm tempted to
believe one must be the best. Hardly ever am I right.
=head1 The Origin of this Chapter
-This chapter has been contributed to the Guide by Andreas Koenig. You
-will find the references and other related info at the bottom of this
-page. It was previously distributed from CPAN, but this Guide is now its
-official resting-place.
+This chapter has been contributed to the documentation by Andreas
+Koenig. You will find the references and other related info at the
+bottom of this page. It was previously distributed from CPAN, but this
+documentation is now its official resting-place.
If you have any questions regarding this specific document only,
please refer to Andreas, since he is the guru on this subject. On any
-other matter please contact the mod_perl mailing list.
+other matter please contact the L<mod_perl mailing
+list|maillist::modperl>.
=head1 Why Headers
@@ -123,7 +122,7 @@
use Date::Parse;
# Date::Parse parses RCS format, Apache::Util::parsedate doesn't
$Mtime ||=
- Date::Parse::str2time(substr q$Date: 2002/05/11 11:54:45 $, 6);
+ Date::Parse::str2time(substr q$Date: 2002/05/29 05:03:41 $, 6);
$r->set_last_modified($Mtime);
=head3 Expires and Cache-Control
1.5 +69 -32 modperl-docs/src/docs/general/cvs_howto.pod
Index: cvs_howto.pod
===================================================================
RCS file: /home/cvs/modperl-docs/src/docs/general/cvs_howto.pod,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- cvs_howto.pod 12 May 2002 05:41:22 -0000 1.4
+++ cvs_howto.pod 29 May 2002 05:03:41 -0000 1.5
@@ -1,6 +1,6 @@
=head1 NAME
-CVS HowTo
+CVS Howto
=head1 Description
@@ -13,18 +13,18 @@
everyone has access the latest version and can help see to it that
mod_perl does compile and work on all platforms, with the various
versions and configurations of Perl and Apache. Patches are always
-welcome, simply testing the latest snapshots is just as, if not more
-helpful.
+welcome and simply testing the latest snapshots is just as, if not
+more helpful.
It's recommended to subscribe to the L<modperl-cvs|maillist::cvs>
list, which is the place cvs commit logs and diffs are mailed to; at
least if you're going to work on the code.
-=head1 anoncvs
+=head1 Anonymous CVS
You can get cvs here: http://www.cvshome.org/
-=head2 checkout
+=head2 Checking Out
To checkout a fresh copy run the following commands from the directory
you want the sources to stay in:
@@ -35,19 +35,19 @@
% cvs -d ":pserver:[EMAIL PROTECTED]:/home/cvspublic" co modperl
-After cvs finished downloading the files you will find a new directory
-called I<modperl> in the current working directory.
+After cvs has finished downloading the files you will find a new
+directory called I<modperl> in the current working directory.
=head2 keeping your copy up to date
To keep your local copy in sync with the repository, do
- % cvs -dP update
+ % cvs update -dP
in the top directory of the project. You should run update evertime
before you start working on the project.
-=head2 sending patches
+=head2 Sending Patches
To send a patch, first run:
@@ -72,9 +72,10 @@
instead.
-Then send your patch to the maintainer of the project.
+Then send your patch to the maintainer of the project, or the
+appropriate mailing list.
-=head2 usefull default parameters
+=head2 Useful Default Parameters
Here are some recommended parameters. Save them in I<~/.cvsrc>, so
you don't have to type them everytime you use cvs.
@@ -83,19 +84,31 @@
update -dP
diff -u
+=over
+
+=item *
+
I<cvs -z9> sets the compression level to 9 (the highest value) to
speed up downloading.
+=item *
+
I<update -d> automatically creates directories that are missing in
your local copy because they where added to the repository after your
initial checkout or your last update.
+=item *
+
I<update -P> automatically deletes empty directories.
+=item *
+
I<diff -U> to use the unified output format so that your changes can
be easily merged back into the repository.
-=head1 cvsup
+=back
+
+=head1 Cvsup
Cvsup has come out of the FreeBSD group. It's a client/server beast
that offers an efficient way to sync collections of files over the
@@ -103,33 +116,47 @@
repositories or checked out files using the cvs deltas to bring the
client side files up to date with minimal data transfer.
-For a FreeBSD cvsup client see:
-
+For a FreeBSD cvsup client see
http://www.freebsd.org/cgi/ports.cgi?query=cvsup&stype=all
-Others (SunOS, alpha.osf, linux, Solaris2.4, HPAA 10.2, irix)
+Others (SunOS, alpha.osf, linux, Solaris2.4, HPAA 10.2, irix):
ftp://ftp.postgresql.org/pub/CVSup/
Here's a config file for the client (cvsup) to sync modperl sources.
*default tag=.
# comment out the above if you want the raw cvs files
-
+
*default host=cvs.apache.org
*default prefix=/path/on/this/machine/to/install/
# a subdir for modperl will appear here ^^^
-
+
*default base=/path/on/this/machine/where/cvsup/will/keep/status/info
# you'll never need to look in the 'base' dir.
-
+
*default release=cvs delete use-rel-suffix compress
-
+
modperl
- #apache-src
+ #apache-1.3
#apache-docs
- #uncomment these two for the latest apache src and/or docs if you want them
+ #modperl-2.0
+ #httpd-2.0
+ #modperl-docs
+ #make your picks above by uncommenting the entries
+
+
+=head1 Inspecting the CVS server with ViewCVS
+
+ViewCVS is installed on the Apache CVS server. You can reach it at
+http://cvs.apache.org/viewcvs.cgi/.
-=head1 mod_perl and related projects on cvs.apache.org
+From there you can browse the list of available projects, look at the
+files contained in those projects, their logs, and do colored diffs
+between versions. This is information you can get from your CVS client
+(through C<cvs log>, C<cvs diff> and friends), but the web interface
+makes it much easier to get a good overview of the different files.
+
+=head1 mod_perl and Related Projects on cvs.apache.org
=over
@@ -141,9 +168,11 @@
the Apache 1.3 HTTP Server
-=item mod_perl-2.0
+=item modperl-2.0
-the new version of mod_perl, for use with httpd-2.0
+the new version of mod_perl, for use with httpd-2.0. See the L<install
+docs|docs::2.0::user::install::install> for more information about
+downloading the 2.0 components and installing them.
=item httpd-2.0
@@ -151,15 +180,17 @@
=item apr
-needed for mod_perl-2.0
+needed for modperl-2.0
=item apr-util
-needed for mod_perl-2.0
+needed for modperl-2.0
-=item mod_perl-docs
+=item modperl-docs
-the mod_perl documentation (i.e. this site)
+the mod_perl documentation (i.e. this site). See the L<documentation
+download|download::docs> for information on how to download, build and
+submit patches to the documentation.
=back
@@ -169,11 +200,15 @@
=over
-=item * http://httpd.apache.org/dev/anoncvs.txt
+=item *
+
+http://httpd.apache.org/dev/anoncvs.txt
-For a basic introduction to anoncvs
+For a basic introduction to Anonymous CVS on the Apache CVS server.
-=item * http://cvsbook.red-bean.com/
+=item *
+
+http://cvsbook.red-bean.com/
Open Source Development with CVS is a book published by Coriolis Inc.
as part of the Coriolis OpenPress series. Chapters 2, 4, 6, 8, 9, and
@@ -181,7 +216,9 @@
CVS -- are being released free under the terms of the GNU General
Public License.
-=item * http://www.cvshome.org/docs/manual/
+=item *
+
+http://www.cvshome.org/docs/manual/
Version Management with CVS by Per Cederqvist et al is the "official"
manual for CVS. Commonly known as "the Cederqvist," the manual covers
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
