Bug#589596: libexpect-simple-perl: We need tests (and examples)

[intrigeri]

Control: tag -1 + upstream
Control: retitle -1 Upstream documentation could be clearer

Hi,

Gordon Haverland (2010-07-18):
> If one looks at the man page for Expect::Simple, we see:

[... copy of the synopsis]

> The manpage code snippet does not define $cmd.

I think that's OK as far as the synopsis is concerned.

> Even looking at the send() command on the man page doesn't
> really tell someone what $cmd is supposed to be.

I see how it could be made clearer upstream.

> An example that I guess
> I will figure out myself, is what if the first send() isn't needed?  Am
> I supposed to send a zero length string, UNDEF, or not even call send()?

The description reads:
"Generally, one starts by creating an Expect::Simple object using new.
This will start up the target program, and will wait until one of the
specified prompts is output by the target. At that point the caller
should send() commands to the program; the results are available via"

I don't see how an Expect module can be useful without sending
commands to the interactive prompt.

> But a general comment as far as all CPAN modules goes, we really do need
> the tests and any examples that are in the CPAN package.

We do ship the tests in the source package.

When upstream provides example scripts, we include them in the
binary package. In this case there are none so we can't include them :)

> And it would
> be really nice if the web page describing libexpect-simple-perl (or
> any libXXX-perl package) would actually say that this is the CPAN XXX
> package.

Indeed, this info is only available in the long description of the
binary package, that for example is not visible on the tracker:
https://tracker.debian.org/pkg/libexpect-simple-perl

But if you click on the binary package link on that page, you land on
https://packages.debian.org/unstable/libexpect-simple-perl, which
includes the desired info.

So, all in all, I think the only actionable aspect of this wishlist
bug report are upstream stuff. Tagging accordingly.