diff options
| author | Sebastiano Tronto <sebastiano@tronto.net> | 2024-09-26 14:59:11 +0200 |
|---|---|---|
| committer | Sebastiano Tronto <sebastiano@tronto.net> | 2024-09-26 15:00:16 +0200 |
| commit | 818186b480d7c05e0c58ff89da2180f5b2476434 (patch) | |
| tree | 0f6e4919d4001775a4820dffd29448dbd20c00db /README.md | |
| parent | bb09e52a7481718ae1fe324d16b99970450908f8 (diff) | |
| download | nissy-core-818186b480d7c05e0c58ff89da2180f5b2476434.tar.gz nissy-core-818186b480d7c05e0c58ff89da2180f5b2476434.zip | |
Added TOOLARGS and simplified gendata tool(s)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 17 insertions, 5 deletions
| @@ -61,7 +61,7 @@ The results of the last test case run is saved in test/last.out (standard | |||
| 61 | output, the results compared with the .out files) and test/last.err | 61 | output, the results compared with the .out files) and test/last.err |
| 62 | (standard error). | 62 | (standard error). |
| 63 | 63 | ||
| 64 | Tests are always run in "debug mode": this means that optimizations are | 64 | Tests are always run in debug mode: this means that optimizations are |
| 65 | disabled and some extra logging is enabled. | 65 | disabled and some extra logging is enabled. |
| 66 | 66 | ||
| 67 | See the test folder and test/test.sh for details. | 67 | See the test folder and test/test.sh for details. |
| @@ -70,7 +70,7 @@ See the test folder and test/test.sh for details. | |||
| 70 | 70 | ||
| 71 | In the tools folder there are some small programs that test various | 71 | In the tools folder there are some small programs that test various |
| 72 | functionality of the H48 library. They work similarly to test, but they | 72 | functionality of the H48 library. They work similarly to test, but they |
| 73 | are not run in debug mode. | 73 | are not run in debug mode by default. |
| 74 | 74 | ||
| 75 | To run a tool you must select it with the environment variable `TOOL`. | 75 | To run a tool you must select it with the environment variable `TOOL`. |
| 76 | For example the command: | 76 | For example the command: |
| @@ -79,14 +79,26 @@ For example the command: | |||
| 79 | TOOL=stats make tool | 79 | TOOL=stats make tool |
| 80 | ``` | 80 | ``` |
| 81 | 81 | ||
| 82 | Will run the stats_tables_h48 tool. Like for tests, the value of the | 82 | Will run the stats_tables_h48 tool. |
| 83 | `TOOL` variable can be any regular expression matching the name of the | 83 | |
| 84 | tool. Unlike tests, one and only one tool will be selected for each run. | 84 | To pass some arguments to a tool, use the `TOOLARGS` variable: |
| 85 | |||
| 86 | ``` | ||
| 87 | TOOL=gendata TOOLARGS="h48 0;2;20" make tool | ||
| 88 | ``` | ||
| 89 | |||
| 90 | Like for tests, the value of the `TOOL` variable can be any regular | ||
| 91 | expression matching the name of the tool. Unlike tests, one and | ||
| 92 | only one tool will be selected for each run. The content of the | ||
| 93 | `TOOLARGS` variable is used directly as command line arguments for | ||
| 94 | the chosen tool. | ||
| 85 | 95 | ||
| 86 | Each tool run is automatically timed, so these tools can be used as | 96 | Each tool run is automatically timed, so these tools can be used as |
| 87 | benchmark. The output as well as the time of the run are saved to a | 97 | benchmark. The output as well as the time of the run are saved to a |
| 88 | file in the tools/results folder. | 98 | file in the tools/results folder. |
| 89 | 99 | ||
| 100 | To build and run a tool in debug mode, use `make debugtool`. | ||
| 101 | |||
| 90 | ## Running commands manually | 102 | ## Running commands manually |
| 91 | 103 | ||
| 92 | This project also includes a rudimentary shell that can be used to run | 104 | This project also includes a rudimentary shell that can be used to run |