-
Type: Documentation
-
Resolution: Unresolved
-
Priority: Minor - P4
-
None
-
Affects Version/s: None
-
Component/s: None
-
None
Problem:
Some pages in the WiredTiger documentation include the default values for various configuration parameters. Some pages also discuss the min and max values. This is especially common on the tuning documentation (docs/tune-*.dox).
Currently this documentation has to be updated by hand when these values are updated. This is error prone, especially since changes to the defaults are automatically propagated to other parts of the documentation, making it easy for developers to assume there isn't anything else they need to change after updating dist/api_data.py.
WT-8831 is case where we missed updating the documentation and it took us several years to spot the error.
Solution:
We should automatically fill in these values from api_data.py as part of generating the documentation.
- is related to
-
WT-8831 Correct tuning documentation for split_pct parameter
- Closed