[jira] [Created] (OAK-6236) Improve the help output from oak-run commands

["Chetan Mehrotra (JIRA)" <ji...@apache.org>]

Chetan Mehrotra created OAK-6236:
------------------------------------

             Summary: Improve the help output from oak-run commands
                 Key: OAK-6236
                 URL: https://issues.apache.org/jira/browse/OAK-6236
             Project: Jackrabbit Oak
          Issue Type: Technical task
          Components: run
            Reporter: Chetan Mehrotra
            Assignee: Chetan Mehrotra
             Fix For: 1.8


Default help output dumps all options in shot. From the output its not clear which is relevant to what. For e.g output below does not make it clear which option is relevent when connecting to DocumentNodeStore, which is for BlobStore etc. 

This should be improved to have separate section for different category of options

{noformat}
Non-option arguments:                             
[String] -- {<path-to-repository> | <mongodb-uri>}

Option                               Description                                                                     
------                               -----------                                                                     
-?, -h, --help                       show help                                                                       
--azureblobds <String>               AzureBlobStorageDataStore config                                                
--cacheSize <Integer>                cache size (default: 0)                                                         
--clusterId <Integer>                MongoMK clusterId (default: 0)                                                  
--disableBranches                    disable branches                                                                
--fds <String>                       FileDataStore config                                                            
--fds-path <String>                  FileDataStore path                                                              
--index-consistency-check [Integer]  Performs consistency check for indexes as specified by --index-paths. If none   
                                       specified performs check for all indexes. Currently this is only supported for
                                       Lucene indexes. Possible values 1 - Basic check, 2 - Full check (slower)      
                                       (default: 1)                                                                  
--index-definitions                  Collects and dumps index definitions                                            
--index-dump                         Dumps index content                                                             
--index-info                         Collects and dumps information related to the indexes                           
--index-out-dir <File>               Directory used for output files (default: .)                                    
--index-paths <String>               Comma separated list of index paths for which the selected operations need to be
                                       performed                                                                     
--index-work-dir <File>              Work directory used for storing temp files (default: target)                    
--rdbjdbcpasswd [String]             RDB JDBC password (default: )                                                   
--rdbjdbcuser [String]               RDB JDBC user (default: )                                                       
--read-write                         connect to repository in read-write mode                                        
--s3ds <String>                      S3DataStore config    
{noformat}



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)