[SERVER-12507] Add "help" output for various config files Created: 28/Jan/14  Updated: 24/Feb/17  Resolved: 24/Feb/17

Status: Closed
Project: Core Server
Component/s: Admin
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Minor - P4
Reporter: Shaun Verch Assignee: DO NOT USE - Backlog - Platform Team
Resolution: Won't Fix Votes: 2
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:

 Description   

Currently, the --help option only has output for the command line. In theory, we could have it output help for the various config files as well (currently YAML and INI).

The usage would be:

./mongod --help
./mongod --help cmdline
# Outputs command line help
./mongod --help yaml
# Outputs YAML config help which can also act as template config file
./mongod --help ini
# Outputs INI config help which can also act as template config file

The help for the config files would have comments that are the option descriptions in the code. The INI would be done manually (the generator should be simple) and the YAML parser we are using supports comment output: https://code.google.com/p/yaml-cpp/wiki/HowToEmitYAML



 Comments   
Comment by Justin Cohler [ 24/Feb/17 ]

This is a minor feature request. Due to the # of tickets higher in our roadmap, we don't intend to take this feature request on. Please re-open if you would like to raise this priority.

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