module-build-general

[Module::Build] create_readme =>1 doesn't cause README to be added to MANIFEST

[Sagar S. <sag...@so...>]

Hi,

I found the create_readme feature by searching the mailing lists ( i was
just about to submit an enhancement for it)=20

I don't see it in the docs of Module::Build 0.21, but i do see it in the
code. Since the original mail trail was back in september i decided to
assume it was complete and gave it a go.

One problem that i've found is that when generating the MANIFEST
Module::Build doesn't add the README to it, and so it doesn't actually
get includede in the dist tarball...

Bug?

Regards

Sagar

--=20
Sagar Shah <sag...@so...>

Re: [Module::Build] create_readme =>1 doesn't cause README to be added to MANIFEST

[Ken W. <ke...@ma...>]

On Saturday, November 1, 2003, at 07:54  AM, Sagar Shah wrote:

> Hi,
>
> I found the create_readme feature by searching the mailing lists ( i 
> was
> just about to submit an enhancement for it)
>
> I don't see it in the docs of Module::Build 0.21, but i do see it in 
> the
> code. Since the original mail trail was back in september i decided to
> assume it was complete and gave it a go.

Thanks, I've just added some docs for it.


>
> One problem that i've found is that when generating the MANIFEST
> Module::Build doesn't add the README to it, and so it doesn't actually
> get includede in the dist tarball...
>
> Bug?

I'm reluctant to add things automatically to the MANIFEST, because in 
general I don't want to surprise the user about things.  With the 
SIGNATURE file there's a chicken-egg problem that can only be solved by 
adding it to the MANIFEST automatically, but with the README I think 
the author should just add it him/herself.

  -Ken

Re: [Module::Build] create_readme =>1 doesn't cause README to be added to MANIFEST

[Michael G S. <sc...@po...>]

On Fri, Nov 28, 2003 at 03:13:32PM -0600, Ken Williams wrote:
> >One problem that i've found is that when generating the MANIFEST
> >Module::Build doesn't add the README to it, and so it doesn't actually
> >get includede in the dist tarball...
> >
> >Bug?
> 
> I'm reluctant to add things automatically to the MANIFEST, because in 
> general I don't want to surprise the user about things.  With the 
> SIGNATURE file there's a chicken-egg problem that can only be solved by 
> adding it to the MANIFEST automatically, but with the README I think 
> the author should just add it him/herself.

I dunno.  It seems that the Principle of Least Surprise would say that
if you created a README automaticly, you'd want it distributed.  Since
there's little indication to the author that the README is *not* getting
distributed, I'd say the common bug will be an author that sets
create_readme and then forgets to add it to the MANIFEST.  Not the author
that turns on create_readme and doesn't want it in the MANIFEST.


-- 
Michael G Schwern        sc...@po...  http://www.pobox.com/~schwern/
We don't know.  But if we did, we wouldn't tell you.

Re: [Module::Build] create_readme =>1 doesn't cause README to be added to MANIFEST

[Sagar S. <sag...@so...>]

On Wed, 2003-12-03 at 06:31, Michael G Schwern wrote:
> On Fri, Nov 28, 2003 at 03:13:32PM -0600, Ken Williams wrote:
> > >One problem that i've found is that when generating the MANIFEST
> > >Module::Build doesn't add the README to it, and so it doesn't actually
> > >get includede in the dist tarball...
> > >
> > >Bug?
> >=20
> > I'm reluctant to add things automatically to the MANIFEST, because in=20
> > general I don't want to surprise the user about things.  With the=20
> > SIGNATURE file there's a chicken-egg problem that can only be solved by=
=20
> > adding it to the MANIFEST automatically, but with the README I think=20
> > the author should just add it him/herself.
>=20
> I dunno.  It seems that the Principle of Least Surprise would say that
> if you created a README automaticly, you'd want it distributed.  Since
> there's little indication to the author that the README is *not* getting
> distributed, I'd say the common bug will be an author that sets
> create_readme and then forgets to add it to the MANIFEST.  Not the author
> that turns on create_readme and doesn't want it in the MANIFEST.

Ken,

I agree with Michael's comments, but the use case where i hit this was
where I don't even have a MANIFEST. I just use a MANIFEST.SKIP and have
M::B create my MANIFEST for me.=20

So you see, i cannot add README to the MANIFEST because i don't have a
self made MANIFEST. create_readme doesn't cause the README to be created
before the MANIFEST is generated. So perhaps if you don't want
create_readme to explicty insert README into MANIFEST, perhaps you can
change the ordering of the actions slightly?=20

That way users who do have a MANIFEST will not get surprised by extra
additions. Whereas users with no MANIFEST, will 'get the right
manifest'.

Warming to the idea @ all?

Cheers

Sagar

--=20
Sagar Shah <sag...@so...>

Re: [Module::Build] create_readme =>1 doesn't cause README to be added to MANIFEST

[Ken W. <ke...@ma...>]

On Monday, December 15, 2003, at 03:35  PM, Sagar Shah wrote:
> I agree with Michael's comments, but the use case where i hit this was
> where I don't even have a MANIFEST. I just use a MANIFEST.SKIP and have
> M::B create my MANIFEST for me.
>
> So you see, i cannot add README to the MANIFEST because i don't have a
> self made MANIFEST. create_readme doesn't cause the README to be 
> created
> before the MANIFEST is generated. So perhaps if you don't want
> create_readme to explicty insert README into MANIFEST, perhaps you can
> change the ordering of the actions slightly?
>
> That way users who do have a MANIFEST will not get surprised by extra
> additions. Whereas users with no MANIFEST, will 'get the right
> manifest'.
>
> Warming to the idea @ all?

Okay, y'all convinced me.  Could I get a patch from someone?  An 
add_to_manifest() method would be nice, it could also be used to handle 
the SIGNATURE file.

  -Ken