Tue Aug 26 07:33:35 2008: Request 12104 was acted upon.
Transaction: Correspondence added by PJF
       Queue: PAR
     Subject: Some documentation on "--tempcache"?
   Broken in: 0.87
    Severity: Wishlist
       Owner: Nobody
  Requestors: P.Schaffnit@access.rwth-aachen.de
      Status: open
 Ticket <URL: http://rt.cpan.org/Ticket/Display.html?id=12104 >


G'day Philippe and Steffen,

On Mon Mar 27 05:42:44 2006, P.Schaffnit@access.rwth-aachen.de wrote:

> 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>,