Description / Background
Many of our scripts that are intended for users take a number of command line arguments that have to be in a specific order, sometimes with optional arguments that have to be passed at the end. The only documentation available at the point of use is the usage message, which just gives names of the arguments that can be passed, and their order.
In the following issue we converted a number of scripts to an approach that includes help text, and limits the number of positional arguments:
We'd like to apply the same approach to the most commonly used scripts, and make them more usable. This includes the following scripts:
filesStatusReport.shlistTables.shingestJobStatusReport.shingestBatcherReport.shcompactionJobStatusReport.sh
Technical Notes / Implementation Details
See sub-issues.
Description / Background
Many of our scripts that are intended for users take a number of command line arguments that have to be in a specific order, sometimes with optional arguments that have to be passed at the end. The only documentation available at the point of use is the usage message, which just gives names of the arguments that can be passed, and their order.
In the following issue we converted a number of scripts to an approach that includes help text, and limits the number of positional arguments:
We'd like to apply the same approach to the most commonly used scripts, and make them more usable. This includes the following scripts:
filesStatusReport.shlistTables.shingestJobStatusReport.shingestBatcherReport.shcompactionJobStatusReport.shTechnical Notes / Implementation Details
See sub-issues.