[SERVER-14199] Add automated process for extracting option information in machine parseable format Created: 07/Jun/14  Updated: 10/May/22

Status: Backlog
Project: Core Server
Component/s: Usability
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Shaun Verch Assignee: DO NOT USE - Backlog - Platform Team
Resolution: Unresolved Votes: 1
Labels: community-team, move-sa, platforms-re-triaged
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:

 Description   

There has been some effort to create a machine generated list of assertion codes. See https://github.com/mongodb/mongo/blob/r2.6.0/docs/errors.md for an example of the current state of this and https://jira.mongodb.org/browse/DOCS-1519 for the relevant documentation ticket.

Having a machine generated list of the command line options and all their attributes (allowed in config file, allowed in command line, positional, default values, etc.) in a machine parseable format would serve a similar purpose. It would allow for easier documentation of the options in a way that is inherently in sync with the server.

This could be done, for example, by having a hidden option to dump all command line option information, having a command to dump all option information, or even by having some external script read the source code in the same way the assertion codes are collected now.



 Comments   
Comment by Steven Vannelli [ 10/May/22 ]

Moving this ticket to the Backlog and removing the "Backlog" fixVersion as per our latest policy for using fixVersions.

Generated at Thu Feb 08 03:34:08 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.