Projects/bash-ini-parser
1
0
Fork 0
Code Releases Wiki Activity

Added section on error/return codes.

Browse source
This commit is contained in:
Darren 'Tadgy' Austin 2019-08-10 02:22:56 +01:00
commit e94c6af459
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -289,6 +289,22 @@ Booleans
* Later settings of the same key override previous ones - the last one wins. * Later settings of the same key override previous ones - the last one wins.
Error/Return Codes
==================
The parser will return an error code depending upon the success or failure of
processing the INI file. The return codes are as follows:
* **0** - Successful processing of the INI file with no warnings, or the help or
version text was displayed.
* **1** - Complete failure to process the INI file. This could be because:
* Incorrect version of Bash.
* Incorrect command line options, or invalid arguments.
* INI file does not exist, or access permission issue.
* **2** - Partial failure to process the INI file. The parser emitted some
errors during the processing of the INI file - a partial set of array
definitions was written to `stdout`, while the errors were written to `stderr`.
TO-DO TO-DO
===== =====
* Specific section parsing: only parse specified section(s) given on the command * Specific section parsing: only parse specified section(s) given on the command