Skip Menu |

This queue is for tickets about the Apache-ConfigParser CPAN distribution.

Report information
The Basics
Id: 51746
Status: open
Priority: 0/
Queue: Apache-ConfigParser

People
Owner: Nobody in particular
Requestors: FWIE [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: 1.01
Fixed in: (no value)



Subject: [Patch] POD nits
The attached patch fixes some POD, which renders wrong, at least at search.cpan.org.
Subject: pod.patch
diff --git a/lib/Apache/ConfigParser.pm b/lib/Apache/ConfigParser.pm index 2e0d430..9189542 100644 --- a/lib/Apache/ConfigParser.pm +++ b/lib/Apache/ConfigParser.pm @@ -206,7 +206,7 @@ the directive name and if you do not want to modify the filename, return the subroutine's third argument. If the subroutine returns an undefined value or a value with 0 length, -then it is replaced with <File::Spec->devnull> which is the +then it is replaced with C<File::Spec->devnull> which is the appropriate 0 length file for the operating system. This is done to keep a value in the directive name since otherwise the directive may not work properly. For example, with the input @@ -493,7 +493,7 @@ configuration file did not close all of its contexts, such as C<$filename> will be added to the existing context. If there is a failure in parsing any portion of the configuration -file, then this method returns undef and C<$c->errstr> will contain a +file, then this method returns undef and C<< $c->errstr >> will contain a string explaining the error. =cut diff --git a/lib/Apache/ConfigParser.pod b/lib/Apache/ConfigParser.pod index 6f6dfa5..99f1064 100644 --- a/lib/Apache/ConfigParser.pod +++ b/lib/Apache/ConfigParser.pod @@ -206,7 +206,7 @@ the directive name and if you do not want to modify the filename, return the subroutine's third argument. If the subroutine returns an undefined value or a value with 0 length, -then it is replaced with <File::Spec->devnull> which is the +then it is replaced with C<File::Spec->devnull> which is the appropriate 0 length file for the operating system. This is done to keep a value in the directive name since otherwise the directive may not work properly. For example, with the input @@ -493,7 +493,7 @@ configuration file did not close all of its contexts, such as C<$filename> will be added to the existing context. If there is a failure in parsing any portion of the configuration -file, then this method returns undef and C<$c->errstr> will contain a +file, then this method returns undef and C<< $c->errstr >> will contain a string explaining the error. =cut diff --git a/lib/Apache/ConfigParser/Directive.pm b/lib/Apache/ConfigParser/Directive.pm index a4419ba..d5587dd 100644 --- a/lib/Apache/ConfigParser/Directive.pm +++ b/lib/Apache/ConfigParser/Directive.pm @@ -678,7 +678,7 @@ sub value_is_path { =item $d->orig_value_is_path($index_into_value_array) -This has the same behavior as C<$d->value_is_path> except the results +This has the same behavior as C<< $d->value_is_path >> except the results are applicable to C<$d>'s 'original' value array. =cut @@ -733,7 +733,7 @@ sub value_is_abs_path { =item $d->orig_value_is_abs_path($index_into_value_array) -This has the same behavior as C<$d->value_is_abs_path> except the +This has the same behavior as C<< $d->value_is_abs_path >> except the results are applicable to C<$d>'s 'original' value array. =cut @@ -788,7 +788,7 @@ sub value_is_rel_path { =item $d->orig_value_is_rel_path($index_into_value_array) -This has the same behavior as C<$d->value_is_rel_path> except the +This has the same behavior as C<< $d->value_is_rel_path >> except the results are applicable to C<$d>'s 'original' value array. =cut @@ -893,7 +893,7 @@ takes only absolute, only relative or both types of paths. The hash value for the lowercase directive name is a subroutine reference. The subroutine returns 1 if its only argument is a path -and 0 otherwise. The /dev/null equivalent (C<File::Spec->devnull>) +and 0 otherwise. The /dev/null equivalent (C<< File::Spec->devnull >>) for the operating system being used is not counted as a path, since on some operating systems the /dev/null equivalent is not a filename, such as nul on Windows. @@ -916,7 +916,7 @@ or a syslog entry of the two forms: ErrorLog syslog:local7 The particular subroutine for ErrorLog checks if the value is not -equal to C<File::Spec->devnull>, does not begin with a | or does not +equal to C<< File::Spec->devnull >>, does not begin with a | or does not match syslog(:[a-zA-Z0-9]+)?. These subroutines do not remove any "'s before checking on the type of @@ -970,7 +970,7 @@ between directives that take only filenames, only directories or both. The hash value for the lowercase directive name is a subroutine reference. The subroutine returns 1 if its only argument is a path -and 0 otherwise. The /dev/null equivalent (C<File::Spec->devnull>) +and 0 otherwise. The /dev/null equivalent (C<< File::Spec->devnull >>) for the operating system being used is not counted as a path, since on some operating systems the /dev/null equivalent is not a filename, such as nul on Windows. @@ -993,7 +993,7 @@ or a syslog entry of the two forms: ErrorLog syslog:local7 The particular subroutine for ErrorLog checks if the value is not -equal to C<File::Spec->devnull>, does not begin with a | or does not +equal to C<< File::Spec->devnull >>, does not begin with a | or does not match syslog(:[a-zA-Z0-9]+)?. These subroutines do not remove any "'s before checking on the type of diff --git a/lib/Apache/ConfigParser/Directive.pod b/lib/Apache/ConfigParser/Directive.pod index 1e54d66..876c836 100644 --- a/lib/Apache/ConfigParser/Directive.pod +++ b/lib/Apache/ConfigParser/Directive.pod @@ -678,7 +678,7 @@ sub value_is_path { =item $d->orig_value_is_path($index_into_value_array) -This has the same behavior as C<$d->value_is_path> except the results +This has the same behavior as C<< $d->value_is_path >> except the results are applicable to C<$d>'s 'original' value array. =cut @@ -733,7 +733,7 @@ sub value_is_abs_path { =item $d->orig_value_is_abs_path($index_into_value_array) -This has the same behavior as C<$d->value_is_abs_path> except the +This has the same behavior as C<< $d->value_is_abs_path >> except the results are applicable to C<$d>'s 'original' value array. =cut @@ -788,7 +788,7 @@ sub value_is_rel_path { =item $d->orig_value_is_rel_path($index_into_value_array) -This has the same behavior as C<$d->value_is_rel_path> except the +This has the same behavior as C<< $d->value_is_rel_path >> except the results are applicable to C<$d>'s 'original' value array. =cut @@ -893,7 +893,7 @@ takes only absolute, only relative or both types of paths. The hash value for the lowercase directive name is a subroutine reference. The subroutine returns 1 if its only argument is a path -and 0 otherwise. The /dev/null equivalent (C<File::Spec->devnull>) +and 0 otherwise. The /dev/null equivalent (C<< File::Spec->devnull >>) for the operating system being used is not counted as a path, since on some operating systems the /dev/null equivalent is not a filename, such as nul on Windows. @@ -916,7 +916,7 @@ or a syslog entry of the two forms: ErrorLog syslog:local7 The particular subroutine for ErrorLog checks if the value is not -equal to C<File::Spec->devnull>, does not begin with a | or does not +equal to C<< File::Spec->devnull >>, does not begin with a | or does not match syslog(:[a-zA-Z0-9]+)?. These subroutines do not remove any "'s before checking on the type of @@ -970,7 +970,7 @@ between directives that take only filenames, only directories or both. The hash value for the lowercase directive name is a subroutine reference. The subroutine returns 1 if its only argument is a path -and 0 otherwise. The /dev/null equivalent (C<File::Spec->devnull>) +and 0 otherwise. The /dev/null equivalent (C<< File::Spec->devnull >>) for the operating system being used is not counted as a path, since on some operating systems the /dev/null equivalent is not a filename, such as nul on Windows. @@ -993,7 +993,7 @@ or a syslog entry of the two forms: ErrorLog syslog:local7 The particular subroutine for ErrorLog checks if the value is not -equal to C<File::Spec->devnull>, does not begin with a | or does not +equal to C<< File::Spec->devnull >>, does not begin with a | or does not match syslog(:[a-zA-Z0-9]+)?. These subroutines do not remove any "'s before checking on the type of
On this part of the diff: -then it is replaced with <File::Spec->devnull> which is the +then it is replaced with C<File::Spec->devnull> which is the don't you want that replacement line to be: -then it is replaced with <File::Spec->devnull> which is the +then it is replaced with C<< File::Spec->devnull >> which is the This would make it consistent with the rest of the diffs. Regards, Blair
Subject: Re: [rt.cpan.org #51746] [Patch] POD nits
Date: Fri, 20 Nov 2009 09:44:59 +0100
To: bug-Apache-ConfigParser [...] rt.cpan.org
From: Frank Wiegand <frank.wiegand [...] gmail.com>
Am Freitag, den 20.11.2009, 02:19 -0500 schrieb BZAJAC via RT: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=51746 > > > On this part of the diff: > > -then it is replaced with <File::Spec->devnull> which is the > +then it is replaced with C<File::Spec->devnull> which is the > > don't you want that replacement line to be: > > -then it is replaced with <File::Spec->devnull> which is the > +then it is replaced with C<< File::Spec->devnull >> which is the > > This would make it consistent with the rest of the diffs.
Right. New patch is attached.

Message body is not shown because sender requested not to inline it.

Thanks. I've applied the patch to http://www.orcaware.com/svn/repos/perl_apache_configparser/trunk/ . Are there any other changes you want before I go through and cut a new release? Regards, Blair
Subject: Re: [rt.cpan.org #51746] [Patch] POD nits
Date: Sun, 22 Nov 2009 14:10:02 +0100
To: bug-Apache-ConfigParser [...] rt.cpan.org
From: Frank Wiegand <frank.wiegand [...] gmail.com>
Am Freitag, den 20.11.2009, 10:58 -0500 schrieb BZAJAC via RT: Show quoted text
> Are there any other changes you want before I go through and cut a new release?
No, thanks.