[commit: ghc] ghc-8.2: Document hithertoo undocumented HPCTIXFILE option. (309d863)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : ghc-8.2
Link       : http://ghc.haskell.org/trac/ghc/changeset/309d86329dd425157b4dd8351ec2003ce77fc20d/ghc

>---------------------------------------------------------------

commit 309d86329dd425157b4dd8351ec2003ce77fc20d
Author: Edward Z. Yang <ezyang at cs.stanford.edu>
Date:   Thu Mar 23 21:03:40 2017 -0400

    Document hithertoo undocumented HPCTIXFILE option.
    
    Test Plan: none
    
    Reviewers: bgamari, austin, dfeuer
    
    Reviewed By: bgamari, dfeuer
    
    Subscribers: dfeuer, rwbarton, thomie
    
    Differential Revision: https://phabricator.haskell.org/D3357
    
    (cherry picked from commit ee7241cfde455ab6731b9ce81b36247f082a1342)


>---------------------------------------------------------------

309d86329dd425157b4dd8351ec2003ce77fc20d
 docs/users_guide/profiling.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst
index 832464e..d035cc5 100644
--- a/docs/users_guide/profiling.rst
+++ b/docs/users_guide/profiling.rst
@@ -1292,7 +1292,8 @@ case :file:`Recip.tix`, which contains the coverage data for this run of the
 program. The program may be run multiple times (e.g. with different test
 data), and the coverage data from the separate runs is accumulated in
 the ``.tix`` file. To reset the coverage data and start again, just
-remove the ``.tix`` file.
+remove the ``.tix`` file.  You can control where the ``.tix`` file
+is generated using the environment variable :envvar:`HPCTIXFILE`.
 
 Having run the program, we can generate a textual summary of coverage:
 
@@ -1532,8 +1533,10 @@ Caveats and Shortcomings of Haskell Program Coverage
 
 HPC does not attempt to lock the ``.tix`` file, so multiple concurrently
 running binaries in the same directory will exhibit a race condition.
-There is no way to change the name of the ``.tix`` file generated, apart
-from renaming the binary. HPC does not work with GHCi.
+At compile time, there is no way to change the name of the ``.tix`` file generated;
+at runtime, the name of the generated ``.tix`` file can be changed
+using :envvar:`HPCTIXFILE`; the name of the ``.tix`` file
+will also change if you rename the binary.  HPC does not work with GHCi.
 
 .. _ticky-ticky: