Skip Menu |

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the IPC-System-Simple CPAN distribution.

Report information
The Basics
Id: 42705
Status: resolved
Priority: 0/
Queue: IPC-System-Simple

People
Owner: PJF [...] cpan.org
Requestors: rwan [...] kuicr.kyoto-u.ac.jp
Cc:
AdminCc:

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



Subject: Documentation typos (v1.17)
Date: Fri, 23 Jan 2009 17:19:36 +0900
To: bug-IPC-System-Simple [...] rt.cpan.org
From: Raymond Wan <rwan [...] kuicr.kyoto-u.ac.jp>
Hi, I found a few typos in the on-line (HTML) documentation. The first is minor; I may be wrong about the others since it could be that I am misunderstanding the commands that end in -x. 1) The section "Advanced Usage" has "Advanced" spelled wrong. 2) In the first box of commands under "Advanced Usage", I think the second "run" should be "runx"? 3) In the fourth box of commands also under "Advanced Usage", I think both "capture"'s should be "capturex"? Thank you! Ray PS: Haven't tried this package yet, but will soon -- exactly what I was looking for; thanks!
G'day Raymond, On Fri Jan 23 03:20:04 2009, rwan@kuicr.kyoto-u.ac.jp wrote: Show quoted text
> I found a few typos in the on-line (HTML) documentation. The first is > minor; I may be wrong about the others since it could be that I am > misunderstanding the commands that end in -x.
Thank-you very much for the bug report! It's very much appreciated. Show quoted text
> 1) The section "Advanced Usage" has "Advanced" spelled wrong.
Oops, this is quite embarrassing. It's now fixed in my code repository[1]. Show quoted text
> 2) In the first box of commands under "Advanced Usage", I think the > second "run" should be "runx"? > 3) In the fourth box of commands also under "Advanced Usage", I think > both "capture"'s should be "capturex"?
The only difference between run/capture and their corresponding -x forms is what they do when passed a single argument. When called with multiple arguments, both run() and capture() (and runx() and capturex() ) will avoid the shell. When called with a single argument, run() and capture() may use the shell, whereas runx() and capturex() will not. As such, the examples in the documentation do really work as they are documented. Since they're being called with multiple arguments, they're equivalent to using runx() or capturex(): run("cat","/etc/motd"); # Execute command without shell # Capture text while avoiding the shell. my $file = capture("cat", "/etc/motd"); my @lines = capture("cat", "/etc/passwd"); The main use for runx/capturex/systemx is when calling them with a single argument, or with a command with an argument list that may be emtpy: runx($cmd); # Never uses the shell. runx($cmd, @args); # Never uses the shell, even if @args = (); If you think there's a better way that I can explain this in the documentation, then I'd appreciate any suggestions you may have. All the very best, Paul [1] https://github.com/pfenwick/ipc-system-simple/
Subject: Re: [rt.cpan.org #42705] Documentation typos (v1.17)
Date: Tue, 27 Jan 2009 11:33:17 +0900
To: bug-IPC-System-Simple [...] rt.cpan.org
From: Raymond Wan <rwan [...] kuicr.kyoto-u.ac.jp>
Hi Paul, Thank you for your prompt reply and your explanation! No, the documentation is fine and it was me who misunderstood things. :-( Sorry about that! On a second read after looking at your e-mail, what you said was there and I don't know how I could have missed it. I mistakenly thought that there were only two forms of the functions: with and without the -x. I see now that there are 3 with the third one supplying an array to the form without the -x. Of course, this behavior is the same as Perl's system/exec, I believe, but I thought that you introduced the -x variant instead to do things differently. Anyway, I see now there are 3 versions and no, nothing you can do in the documentation to make it clearer...me bad... Thanks again for the explanation and the module, in particular! :-) Ray PJF via RT wrote: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=42705 > > > G'day Raymond, > > On Fri Jan 23 03:20:04 2009, rwan@kuicr.kyoto-u.ac.jp wrote: >
>> I found a few typos in the on-line (HTML) documentation. The first is >> minor; I may be wrong about the others since it could be that I am >> misunderstanding the commands that end in -x.
> > Thank-you very much for the bug report! It's very much appreciated. >
>> 1) The section "Advanced Usage" has "Advanced" spelled wrong.
> > Oops, this is quite embarrassing. It's now fixed in my code repository[1]. >
>> 2) In the first box of commands under "Advanced Usage", I think the >> second "run" should be "runx"? >> 3) In the fourth box of commands also under "Advanced Usage", I think >> both "capture"'s should be "capturex"?
> > The only difference between run/capture and their corresponding -x forms > is what they do when passed a single argument. When called with > multiple arguments, both run() and capture() (and runx() and capturex() > ) will avoid the shell. When called with a single argument, run() and > capture() may use the shell, whereas runx() and capturex() will not. > > As such, the examples in the documentation do really work as they are > documented. Since they're being called with multiple arguments, they're > equivalent to using runx() or capturex(): > > run("cat","/etc/motd"); # Execute command without shell > > # Capture text while avoiding the shell. > my $file = capture("cat", "/etc/motd"); > my @lines = capture("cat", "/etc/passwd"); > > The main use for runx/capturex/systemx is when calling them with a > single argument, or with a command with an argument list that may be emtpy: > > runx($cmd); # Never uses the shell. > runx($cmd, @args); # Never uses the shell, even if @args = (); > > If you think there's a better way that I can explain this in the > documentation, then I'd appreciate any suggestions you may have. > > All the very best, > > Paul > > [1] https://github.com/pfenwick/ipc-system-simple/ > >