diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2021-08-02 14:35:42 -0400 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2021-08-23 13:33:41 -0400 |
| commit | 69fb6f6ad16e9d8ee3de18f27b6503b470e2d805 (patch) | |
| tree | dcf973b34111eff250fe3d6bd2089d5c14304201 /docs | |
| parent | ad28ae41206e3a8b483b067a8e3333df445010b6 (diff) | |
| download | haskell-69fb6f6ad16e9d8ee3de18f27b6503b470e2d805.tar.gz | |
users guide: Document -hpcdir flag
Previously this was undocumented.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/users_guide/expected-undocumented-flags.txt | 1 | ||||
| -rw-r--r-- | docs/users_guide/profiling.rst | 12 |
2 files changed, 12 insertions, 1 deletions
diff --git a/docs/users_guide/expected-undocumented-flags.txt b/docs/users_guide/expected-undocumented-flags.txt index 9861386d0c..493a713e25 100644 --- a/docs/users_guide/expected-undocumented-flags.txt +++ b/docs/users_guide/expected-undocumented-flags.txt @@ -85,7 +85,6 @@ -fversion-macros -fvia-c -haddock-opts --hpcdir -instantiated-with -keep-hi-file -keep-o-file diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst index 78f96ae8cb..803457fce9 100644 --- a/docs/users_guide/profiling.rst +++ b/docs/users_guide/profiling.rst @@ -1471,6 +1471,18 @@ Options for instrumenting code for coverage :ghc-flag:`-fhpc`, and the :command:`hpc` tool will only show information about those modules. +.. ghc-flag:: -hpcdir⟨dir⟩ + :shortdesc: Set the directory where GHC places ``.mix`` files. + :type: dynamic + :category: coverage + + :default: .hpc + + Override the directory where GHC places the HPC index + (``.mix``) files used by ``hpc`` to understand program + structure. + + The hpc toolkit ~~~~~~~~~~~~~~~ |