[SERVER-54293] resmoke command-specific help is undocumented Created: 04/Feb/21  Updated: 29/Oct/23  Resolved: 24/Feb/21

Status: Closed
Project: Core Server
Component/s: Internal Code
Affects Version/s: None
Fix Version/s: 4.9.0

Type: Bug Priority: Major - P3
Reporter: Billy Donahue Assignee: Siran Wang (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Backwards Compatibility: Fully Compatible
Operating System: ALL
Sprint: STM 2021-02-22, STM 2021-03-08
Participants:
Story Points: 1

 Description   

Example:

 

$ resmoke.py --help 

Shows very little information, and lists all the commands available like "run".

But it doesn't tell you how to get help about these commands.

Each has a HUGE command-specific help option, available like this:

$ resmoke.py run --help 

I found this out only because someone told me about it on Slack. It is not documented.

Basically we need help for the help.



 Comments   
Comment by Githook User [ 24/Feb/21 ]

Author:

{'name': 'Siran Wang', 'email': 'siran.wang@mongodb.com', 'username': 'vincivans'}

Message: SERVER-54293 add instruction and example for resmoke help message
Branch: master
https://github.com/mongodb/mongo/commit/5aa7b616740041902f232480967793a6745faa4e

Comment by Brooke Miller [ 16/Feb/21 ]

robert.guo mentioned that we could add a one-line change to mention that help messages are available for each sub-command

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