Mercurial > repos > public > sbplib_julia

changeset 1302:68dd0c9f5cac tooling/benchmarks

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some notes
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 23 Mar 2023 08:40:58 +0100
parents e1aefebe4ea2
children 2d34290fdc58
files README.md benchmark/benchmark_utils.jl
diffstat 2 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Thu Mar 23 08:40:35 2023 +0100
+++ b/README.md	Thu Mar 23 08:40:58 2023 +0100
@@ -72,7 +72,7 @@
 ```shell
 make docs          # generates files suitable for webserver deployment, i.e with `prettyurls=true`
 make localdocs     # generates files suitable for local viewing in a web browser, i.e `prettyurls=false`
-make opendocs      # view documentation locally
+make opendocs      # build and view documentation locally
 make cleandocs     # cleans up generated files
 ```
 
--- a/benchmark/benchmark_utils.jl	Thu Mar 23 08:40:35 2023 +0100
+++ b/benchmark/benchmark_utils.jl	Thu Mar 23 08:40:58 2023 +0100
@@ -166,4 +166,8 @@
 
 
 # TBD: How to compare against current working directory? Possible to create a temporary commit?
+    # Make a secret temporary commit
+    # run benchmarkresult
+    # uncommit the temporary commit
+    # verbose flag on commit will print the revision id of the new commit.
 # TBD: What parts are PkgBenchmark contributing? Can it be stripped out?