Re: [Module::Build] should Pod::Readme vs. Pod::Text for README creation be a feature?
Status: Beta
Brought to you by:
kwilliams
|
From: Randy W. S. <Ra...@Th...> - 2006-03-05 04:29:10
|
Yitzchak Scott-Thoennes wrote:
> On Sat, Mar 04, 2006 at 10:06:19PM -0500, Randy W. Sims wrote:
>
>>Yitzchak Scott-Thoennes wrote:
>>
>>>Just as META.yml can be forced to build with or without YAML by setting
>>>the YAML_feature, shouldn't README creation depend on a feature?
>>>
>>>The other discrepancy is that Pod::Readme is recommended but YAML is
>>>not; seems to me both or neither should be listed in recommends: in
>>>META.yml. Same with the other feature-enabling modules. If not,
>>>what are the criteria for what goes in recommends: and what doesn't?
>>
>>The requirement for creating README can't be properly expressed with
>>current limitations; It depends on (Pod::Readme || Pod::Text). The best
>>we can do is recommend one or both.
>
>
> Pod::Text has been in the core since 5.002. But even if it wasn't,
> Pod::Readme makes a better README file; Pod::Text is just a fallback.
> Hence the recommendation.
>
> I see a parallel with YAML; YAML makes a better META.yml than the
> fallback, so it should be recommended.
Sorry, I guess I forgot about Pod::Text being in core. I can see the
parallel. Would the attached patch be ok?
Can I also suggest a slight rewording of the auto_features descriptions?
( s/^Can (.)/\u$1/ )
@@ -51,28 +51,28 @@
auto_features => {
YAML_support =>
{
- description => "Can write fully-functional META.yml files",
+ description => "Write fully-functional META.yml files",
requires => { YAML => ' >= 0.35, != 0.49_01 ' },
},
README_support =>
{
- description => "Can write improved README files",
+ description => "Write improved README files",
requires => { 'Pod::Readme' => '0.04', },
},
C_support =>
{
- description => "Can compile/link C & XS code",
+ description => "Compile/link C & XS code",
requires => { 'ExtUtils::CBuilder' => 0.15, },
recommends => { 'ExtUtils::ParseXS' => 1.02, },
},
manpage_support =>
{
- description => "Can create Unix man pages",
+ description => "Create Unix man pages",
requires => { 'Pod::Man' => 0 },
},
HTML_support =>
{
- description => "Can create HTML documentation",
+ description => "Create HTML documentation",
requires => { 'Pod::Html' => 0 },
},
},
|