Skip to content

Commit 97744ed

Browse files
authored
fix(): README.md corrections
1 parent 9f0514e commit 97744ed

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,20 +41,20 @@ Find below a table listing all the different parameters you can use with the con
4141
| `LOOPS` | Environment | | The number of test loops performed on the test file.<br>This parameter overrides the `RUNTIME` parameter. |
4242
| `/disk` | Volume | | The target path to benchmark. |
4343

44-
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.
44+
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.
4545

4646
### With parameters
4747

48-
For example, you could go and use a 4 GB file looping each test twice, and writting only zeros instead of random data.
48+
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.
4949
You can achieve this using the following command:
5050
```
51-
docker run -it --rm -e SIZE=4G -e LOOPS=2 -e DATA=0x00 e7db/diskmark
51+
docker run -it --rm -e SIZE=4G -e WARMUP=1 -e LOOPS=2 -e DATA=0x00 e7db/diskmark
5252
```
5353

5454
### Force profile
5555

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

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

74-
Construct you custom chain, then run the benchmark using the following command:
74+
Construct your custom chain, then run the benchmark using the following command:
7575
```
7676
docker run -it --rm -e JOB=RND4KQ32T16 e7db/diskmark
7777
```

0 commit comments

Comments
 (0)