Mailing List Archive: Suggestion for INSTALL doc

Suggestion for INSTALL doc

Aug 5, 2004, 9:31 AM

Post #1 of 4 (3157 views)

Greetings,

I've installed mp2 several times, always using the the INSTALL file as a
quick reference. Last night I dug into the docs to fine tune a production
installation and came across this gem of a link:

http://perl.apache.org/docs/2.0/user/install/install.html#Apache

The unescaped logs have been driving me nuts for the past few months. It
is my fault that I did not read the pod initially, but in case there are
other dorks out there like me I would like to suggest the following
addition to the INSTALL file.

--- INSTALL 2003-08-29 14:29:44.000000000 -0400
+++ INSTALL 2004-08-05 12:13:37.896644688 -0400
@@ -27,3 +27,7 @@
PerlModule Apache::compat

See docs/user/config/config.pod for details.
+
+If your error_log is unescaped using Apache >= 2.0.49 see this link
+
+http://perl.apache.org/docs/2.0/user/install/install.html#Apache

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org

Re: Suggestion for INSTALL doc [ In reply to ]

stas at stason

Aug 5, 2004, 12:47 PM

Post #2 of 4 (3010 views)

Permalink

Fred Moyer wrote:
> Greetings,
>
> I've installed mp2 several times, always using the the INSTALL file as a
> quick reference. Last night I dug into the docs to fine tune a production
> installation and came across this gem of a link:
>
> http://perl.apache.org/docs/2.0/user/install/install.html#Apache
>
> The unescaped logs have been driving me nuts for the past few months. It
> is my fault that I did not read the pod initially, but in case there are
> other dorks out there like me I would like to suggest the following
> addition to the INSTALL file.
>
> --- INSTALL 2003-08-29 14:29:44.000000000 -0400
> +++ INSTALL 2004-08-05 12:13:37.896644688 -0400
> @@ -27,3 +27,7 @@
> PerlModule Apache::compat
>
> See docs/user/config/config.pod for details.
> +
> +If your error_log is unescaped using Apache >= 2.0.49 see this link
> +
> +http://perl.apache.org/docs/2.0/user/install/install.html#Apache

This is not going to work. Attempting to keep two sources in sync is
mad. I'd rather see INSTALL shrinking to:

INSTALL:
Refer to docs/user/intro/start_fast.pod
or for more detailed documentation see:
docs/user/install/install.pod and docs/user/config/config.pod

--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org

Re: Suggestion for INSTALL doc [ In reply to ]

fred at taperfriendlymusic

Aug 5, 2004, 8:40 PM

Post #3 of 4 (3011 views)

Permalink

> This is not going to work. Attempting to keep two sources in sync is
> mad. I'd rather see INSTALL shrinking to:
>
> INSTALL:
> Refer to docs/user/intro/start_fast.pod
> or for more detailed documentation see:
> docs/user/install/install.pod and docs/user/config/config.pod

I think this approach would encourage users to read the docs rather than
using the current INSTALL file as a cheat sheet, which is a bad habit I
got into unfortunately.

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org

Re: Suggestion for INSTALL doc [ In reply to ]

stas at stason

Aug 6, 2004, 5:12 PM

Post #4 of 4 (3030 views)

Permalink

Fred Moyer wrote:
>>This is not going to work. Attempting to keep two sources in sync is
>>mad. I'd rather see INSTALL shrinking to:
>>
>>INSTALL:
>>Refer to docs/user/intro/start_fast.pod
>>or for more detailed documentation see:
>>docs/user/install/install.pod and docs/user/config/config.pod
>
>
> I think this approach would encourage users to read the docs rather than
> using the current INSTALL file as a cheat sheet, which is a bad habit I
> got into unfortunately.

Thanks Fred, I'll do that.

--
__________________________________________________________________
Stas Bekman JAm_pH ------> Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide ---> http://perl.apache.org
mailto:stas@stason.org http://use.perl.org http://apacheweek.com
http://modperlbook.org http://apache.org http://ticketmaster.com

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-dev-help@perl.apache.org