Bug #12104 for PAR: Some documentation on "--tempcache"?

Fri Apr 01 02:08:12 2005 Guest - Ticket created

Subject:

Some documentation on "--tempcache"?

Hi! I don't actually think that I'm really reporting a bug, I don't seem to get "--tempcache" to work (or at least not in any way that I can notive...): it's most likely that I'm doing something wrong or I am expecting from it things it's not meant to do, but... Could anyone clarify things a bit for me? Thanks! Philippe PS: this behaviour (i.e.: nothings seems to happen) is quite consistent: under Linux, Windows and Solaris... I am using 0.87

Sun Mar 26 13:33:05 2006 smueller [...] cpan.org - Correspondence added

Hi, On Fr. 01. Apr. 2005, 02:08:12, guest wrote: Show quoted text

> I don't actually think that I'm really reporting a bug, I don't seem > to get "--tempcache" to work (or at least not in any way that I can > notive...): it's most likely that I'm doing something wrong or I am > expecting from it things it's not meant to do, but... > > Could anyone clarify things a bit for me?

I am using PAR 0.92 on 5.8.6, Linux. Quoting the documentation of pp: -T, --tempcache Set the program unique part of the cache directory name that is used if the program is run without -C. If not set, a hash of the executable is used. When the program is run, its contents are extracted to a temporary directory. On my system, that is /tmp/par-USERNAME/cache-XXXXXXX. USERNAME is replaced by the user running the program and XXXXXXX is either a hash of the executable or whatever you set using -T or --tempcache. Example: Program: t.pl #!/usr/bin/perl print "Hello World\n"; Then, compile it using pp: % pp -o t1 t.pl Run it and look at the cache directory: % ./t1 Hello World! % ls /tmp/par-tsee/ cache-2c513f149e737ec4063fc1d37aee9beabc4b4bbf Then compile using pp -T fooo: % pp -o t2 -T fooo t.pl Run it and look at the cache directory again: % ./t2 Hello World! % ls /tmp/par-tsee/ cache-2c513f149e737ec4063fc1d37aee9beabc4b4bbf cache-fooo Does that illustrate the effect of -T? Can you reproduce the effect? Note that this applies only if -C isn't set because with -C, the cache dir won't remain on your hard disk. Please tell me what you think should be done. Is the documentation clear enough? Steffen

Sun Mar 26 13:33:06 2006 The RT System itself - Status changed from 'new' to 'open'

Mon Mar 27 05:42:44 2006 P.Schaffnit [...] access.rwth-aachen.de - Correspondence added

Subject:	Re: [rt.cpan.org #12104] Some documentation on "--tempcache"?
Date:	Mon, 27 Mar 2006 12:42:08 +0200
To:	bug-PAR [...] rt.cpan.org
From:	Philippe Schaffnit <P.Schaffnit [...] access.rwth-aachen.de>

Hi! Once again, thanks a lot for following-up this one too. I had figure this one out in between: what I misunderstood is that I expected "par-USERNAME" to be replace by the value of "--tempcache", and I read the documentation with this pre-conceived idea, hence this report: I believe that the documentation would be more explicit if your second paragraph was appended, but that's a matter of taste, and it does make it longer... Whatever I really got confused with this bit, but I might not be representative of the "normal" user... Your call... Thanks a lot! Philippe Steffen Müller via RT wrote: Show quoted text

> > <URL: http://rt.cpan.org/Ticket/Display.html?id=12104 > > > Hi, > > On Fr. 01. Apr. 2005, 02:08:12, guest wrote:

> > I don't actually think that I'm really reporting a bug, I don't seem > > to get "--tempcache" to work (or at least not in any way that I can > > notive...): it's most likely that I'm doing something wrong or I am > > expecting from it things it's not meant to do, but... > > > > Could anyone clarify things a bit for me?

> > I am using PAR 0.92 on 5.8.6, Linux. > > Quoting the documentation of pp: > > -T, --tempcache > Set the program unique part of the cache directory name that is > used if the program is run without -C. If not set, a hash of the > executable is used. > > When the program is run, its contents are extracted to a temporary > directory. On my system, that is /tmp/par-USERNAME/cache-XXXXXXX. > USERNAME is replaced by the user running the program and XXXXXXX is > either a hash of the executable or whatever you set using -T or > --tempcache. Example: > > Program: t.pl > #!/usr/bin/perl > print "Hello World\n"; > > Then, compile it using pp: > % pp -o t1 t.pl > > Run it and look at the cache directory: > % ./t1 > Hello World! > % ls /tmp/par-tsee/ > cache-2c513f149e737ec4063fc1d37aee9beabc4b4bbf > > Then compile using pp -T fooo: > % pp -o t2 -T fooo t.pl > > Run it and look at the cache directory again: > % ./t2 > Hello World! > % ls /tmp/par-tsee/ > cache-2c513f149e737ec4063fc1d37aee9beabc4b4bbf > cache-fooo > > Does that illustrate the effect of -T? Can you reproduce the effect? > Note that this applies only if -C isn't set because with -C, the cache > dir won't remain on your hard disk. > > Please tell me what you think should be done. Is the documentation clear > enough? > > Steffen

Tue Aug 26 07:33:35 2008 PJF [...] cpan.org - Correspondence added

RT-Send-CC:

wyp3rlx02 [...] sneakemail.com

G'day Philippe and Steffen, On Mon Mar 27 05:42:44 2006, P.Schaffnit@access.rwth-aachen.de wrote: Show quoted text

> I had figure this one out in between: what I misunderstood is that I > expected "par-USERNAME" to be replace by the value of "--tempcache", and > I read the documentation with this pre-conceived idea, hence this > report: I believe that the documentation would be more explicit if your > second paragraph was appended, but that's a matter of taste, and it does > make it longer...

From my blind reading of the documentation, I would have made the mistake. I've committed a slightly edited copy of Steffen's second paragraph of explanation as commit 680 to the source tree, and documented this in the changelog for the next release. For quick reference, the change to pp.pm in r680 is reproduced as a patch below. Steffen, if I've misunderstood anything, then please feel free to correct me. If the documentation change can be considered to clarify this matter sufficiently, I believe we can mark this ticket as closed. Cheerio, Paul Index: lib/pp.pm =================================================================== --- lib/pp.pm (revision 679) +++ lib/pp.pm (working copy) @@ -373,6 +373,12 @@ if the program is run without -C. If not set, a hash of the executable is used. +When the program is run, its contents are extracted to a temporary +directory. On Unix systems, this is commonly +F</tmp/par-USERNAME/cache-XXXXXXX>. F<USERNAME> is replaced by the +user running the program, and F<XXXXXXX> is either a hash of the +executable or the value passed to the C<-T> or C<--tempcache> switch. + =item B<-v>, B<--verbose>[=I<NUMBER>] Increase verbosity of output; I<NUMBER> is an integer from C<1> to C<3>,

Thu Aug 28 08:58:30 2008 smueller [...] cpan.org - Correspondence added

Thanks, Paul. Given your documentation patch, I'll mark this issue as resolved. Best regards, Steffen

Thu Aug 28 08:58:35 2008 smueller [...] cpan.org - Status changed from 'open' to 'resolved'