Skip to content

Commit

Permalink
fix(): README.md corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
e7d authored Mar 30, 2024
1 parent 9f0514e commit 97744ed
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,20 @@ Find below a table listing all the different parameters you can use with the con
| `LOOPS` | Environment | | The number of test loops performed on the test file.<br>This parameter overrides the `RUNTIME` parameter. |
| `/disk` | Volume | | The target path to benchmark. |

By default, a 1 GB test file is used, using 5 loops for each test, reading and writing random bytes on the disk where Docker is installed.
By default, a 1 GB test file is used, with a 5 seconds duration for each test, reading and writing random bytes on the disk where Docker is installed.

### With parameters

For example, you could go and use a 4 GB file looping each test twice, and writting only zeros instead of random data.
For example, you can use a 4 GB file, looping each test twice, but after a warmup phase, and writting only zeros instead of random data.
You can achieve this using the following command:
```
docker run -it --rm -e SIZE=4G -e LOOPS=2 -e DATA=0x00 e7db/diskmark
docker run -it --rm -e SIZE=4G -e WARMUP=1 -e LOOPS=2 -e DATA=0x00 e7db/diskmark
```

### Force profile

A detection of your disk is made, so the benchmark uses the appropriate profile, `default` or `nvme`.
In the event that the detection returns a wrong value, you can force the use of either of the profiles:
A detection of your disk is tried, so the benchmark uses the appropriate profile, `default` or `nvme`.
In the event that the detection fails, yielding "Unknown", or returns the wrong profile, you can force the use of either of the profiles:
```
docker run -it --rm -e PROFILE=nvme e7db/diskmark
```
Expand All @@ -69,9 +69,9 @@ It is composed of 4 parts:
- `Qyy`, where `yy` is the queue depth
- `Tzz`, where `zz` is the number of threads

In the previous example `RND4KQ32T16`, the job uses random accesses, with a block size of 4K, a queue depth of 32, and 16 threads.
In the previous example `RND4KQ32T16`, the job uses **random accesses**, with a **block size of 4K**, a **queue depth of 32**, and **16 threads**.

Construct you custom chain, then run the benchmark using the following command:
Construct your custom chain, then run the benchmark using the following command:
```
docker run -it --rm -e JOB=RND4KQ32T16 e7db/diskmark
```
Expand Down

0 comments on commit 97744ed

Please sign in to comment.