• The WiredTiger documentation system produces documentation for configuration parameters in https://source.wiredtiger.com/develop/index.html underneath APIs with the config string as a function parameter. There are four types.
  • Per connection: In both WiredTiger > Modules > WiredTiger API > wiredtiger_open and WiredTiger > Modules > WiredTiger API > WT_CONNECTION > reconfigure.
  • Per session: In both WiredTiger > Modules > WiredTiger API > WT_CONNECTION > open_session and WiredTiger > Modules > WiredTiger API > WT_SESSION > reconfigure.
  • Per checkpoint: In WiredTiger > Modules > WiredTiger API > WT_SESSION > checkpoint.
  • Per cursor: In WiredTiger > Modules > WiredTiger API > WT_SESSION > open_cursor.
• However the configuration parameters are left out of the documentation if the Config() has undoc=true.
• The control points should all be undoc=true since they are for internal use only.
• There is a problem. We don’t have documentation for internal use only. The control points should be included in documentation for internal use only. The WiredTiger documentation system should be changed to put undoc=true into a different place for internal use only instead of not generating it at all.

This ticket is to change the WiredTiger documentation system as above, i.e. to put undoc=true documentation into a different place for internal use only instead of not generating it at all.

This change is useful beyond control points: internal use only configuration parameters. It will produce documentation for undoc=true configuration parameters that have nothing to do with control points. This documentation would be used internally by MongoDB employees. Having this documentation might increase the use of these internal use only configuration parameters. It also might allow existing configuration parameters to be marked undoc=true if they are really intended for internal use but were not marked so before since that would suppress the documentation.

This ticket is marked MVP since defined control points should be documented.

Note, the control points implementation tickets are in three time periods:

1. POC - Part of the POC.
2. MVP - Part of the minimal viable product. However, even the POC can be used but less conveniently than the MVP.
3. Future - Enhancements after the MVP.

The title of each ticket starts with the time period.