Просмотр исходного кода

Document that -n and -N are not both needed

Vecna 3 недель назад
Родитель
Сommit
b8af919e2c
1 измененных файлов с 7 добавлено и 10 удалено
  1. 7 10
      README.md

+ 7 - 10
README.md

@@ -172,7 +172,7 @@ Of these 5 bridges, the greatest distance between 0 and the mean was only about
 Our entire artifact can be run with the `./run.sh` script, which accepts the following (optional) arguments:
 
     -n NUM_PERFORMANCE_CORES    (Experiment 1) Use only NUM_PERFORMANCE_CORES threads.
-    -N PERFORMANCE_CORE_RANGE   (Experiment 1) Use the threads specified in PERFORMANCE_CORE_RANGE. -n must also be used.
+    -N PERFORMANCE_CORE_RANGE   (Experiment 1) Use the threads specified in PERFORMANCE_CORE_RANGE.
     -s                          (Experiment 2) Run ./scripts/belarus.sh sequentially, instead of in parallel.
     --fast                      (Experiment 2) Start with pre-processed data.
 
@@ -185,21 +185,18 @@ This process should take around 1–2 hours and requires 20 GB of free disk spac
 - Time: 1 human-minute + 5–20 compute-minutes
 
 ```bash
-./scripts/generate-lox-results.sh [-n NUM_PERFORMANCE_CORES] [-N PERFORMANCE_CORE_RANGE] && \
+./scripts/generate-lox-results.sh [-n NUM_PERFORMANCE_CORES|-N PERFORMANCE_CORE_RANGE] && \
 ./scripts/process-lox-results.sh
 ```
 
-By default, the script will use all available threads (up to the number of processes to be run, which is 16), but you can use `-n NUM_PERFORMANCE_CORES` to restrict it to use only `NUM_PERFORMANCE_CORES` threads.
-
-By default, if the `-n` option is used, the script will use the first `NUM_PERFORMANCE_CORES` threads.
-If these are not the ones you want to use, you can also specify `-N PERFORMANCE_CORE_RANGE` to indicate the specific threads to use.
-**If you use `-N` to indicate a range, please also specify `-n` to indicate the number of values in that range.**
+By default, the script will use all available threads (up to the number of processes to be run, which is 16), but you can use `-n NUM_PERFORMANCE_CORES` to restrict it to use only the first `NUM_PERFORMANCE_CORES` threads.
+If these are not the ones you want to use, you can instead specify `-N PERFORMANCE_CORE_RANGE` to indicate the specific threads to use.
 The script does not compute this for you.
 
 Examples:
-    -n 16               Use threads 0-15
-    -n 7 -N 2-8         Use threads 2-8
-    -n 4 -N 0-1,6,9     Use threads 0,1,6,9
+    -n 16           Use threads 0-15
+    -N 2-8          Use threads 2-8
+    -N 0-2,6,9      Use threads 0,1,2,6,9
 
 These scripts perform benchmarks for:
 1. the development branch of Lox from which we forked (Table 2, in Section 6)