codedownio/time-ghc-modules
1
1
Fork 0
mirror of https://github.com/codedownio/time-ghc-modules.git synced 2024-07-07 09:56:50 +03:00
Code Issues Projects Releases Wiki Activity

Update README.md and add CHANGELOG.md

Browse Source
This commit is contained in:
Tom McLaughlin 2024-02-05 19:15:43 -08:00
parent 42e57e1cbf
commit c04110c380
2 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CHANGELOG.md Normal file
View File

@ -0,0 +1,13 @@
# ChangeLog
## 2.0.0
* Added TreeMap visualizations.
## 1.0.1
* Be able to control dependency paths with environment variables so it's easier to package on Nixpkgs.
## 1.0.0
* Initial release.

14
README.md
View File

@ -58,7 +58,7 @@ stack build --ghc-options "-ddump-to-file -ddump-timings"
# Tips
The script will output its log messages to `stderr` and print the final report path to `stdout` (assuming it didn't exit with a failure). This makes it easy to use the output in scripts. For example:
* The script will output its log messages to `stderr` and print the final report path to `stdout` (assuming it didn't exit with a failure). This makes it easy to use the output in scripts. For example:
``` shell
# Build the report and open it in your browser
@ -70,6 +70,18 @@ The script will output its log messages to `stderr` and print the final report p
> cp $(/path/to/time-ghc-modules/time-ghc-modules) $MY_CI_ARTIFACTS_DIR/
```
* You can also look at the timing of individual components, but doing e.g. `stack build some-component:lib`. But, make sure to clean up any old `.dump-timings` files from previous runs:
``` shell
find . -name "*.dump-timings" | xargs rm
```
* GHC's `-dumpdir` option can be used to consolidate the `.dump-timings` files, so they aren't left all over your source tree. For example:
``` shell
stack build --ghc-options "-ddump-to-file -ddump-timings -dumpdir .ghcdump"
```
# Compatibility
The flag `-ddump-timings` is available for `GHC >= 8.4.1`.