diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2021-08-02 14:35:42 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2021-08-02 14:36:08 -0400 |
| commit | 6b68f32fe50a03b6379730eca5bb39e80524cb9f (patch) | |
| tree | 34a103dd52e3bae5e5d4b70c06a6426773d8bf39 | |
| parent | 54d6b20192fe6fc244248c7766533a768c591bae (diff) | |
| download | haskell-wip/hpc-docs.tar.gz | |
users guide: Document -hpcdir flagwip/hpc-docs
Previously this was undocumented.
| -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 ~~~~~~~~~~~~~~~ |