Skip to content

Commit a15b6f0

Browse files
Document allowed tunables and error handling
Added section on allowed tunables and their validation process.
1 parent 3e64f3c commit a15b6f0

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

doc/Wiki.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,12 +372,21 @@ Tunables are configured using **Key** and **Value** fields in the launch configu
372372

373373
Use the **“+ Add Tunable”** button to add additional entries. Each row can be removed using the **“X”** button.
374374

375+
Tunables are case sensitive, and only allowed tunables will be allowed to be saved in the wizard.
376+
375377
Tunables control runtime behavior and performance characteristics. Most tunables have default values, so you only need to specify a value if you want to override them.
376378

377379
<img width="790" height="176" alt="tunables_gui" src="https://github.com/user-attachments/assets/f78d5471-bfff-4cfb-b6cf-62c787a8e31b" />
378380

379381
<img width="360" height="177" alt="tunables_launchjson" src="https://github.com/user-attachments/assets/0d70044d-d04c-4f47-958c-175c6e67f3f9" />
380382

383+
### List of allowed Tunables
384+
385+
In order to prevent unexpected tunables from being ran, there is a list of allowed tunables at `constants/tunables.json` which contains all valid tunables. Tunables are case sensitive and the values type must match what is expected. For example boolean values will only allow true or false. If a invalid tunable is saved in the `launch.json` , when you attempt to run daffodil you will encounter a error saying `Cancel` or `Ignore invalid tunable`. Cancel will send you back where you fix the error, and Ignore invalid tunable runs daffodil but does not register the invalid tunable. The tunable will stay in your launch.json however. The tunables.json file will be updated as new tunables are added and removed.
386+
387+
<img width="914" height="718" alt="image" src="https://github.com/user-attachments/assets/22b24b29-de7e-4ec9-b012-85fe8f1bb54c" />
388+
389+
381390
### Reference
382391
- https://daffodil.apache.org/tunables/
383392

0 commit comments

Comments
 (0)