diff options
author | kate.ward <kate.ward@forestent.com> | 2013-01-07 22:10:49 +0000 |
---|---|---|
committer | kate.ward <kate.ward@forestent.com> | 2013-01-07 22:10:49 +0000 |
commit | 0a4f16fc4e9bcffa9732c057877aa42e59f0a95b (patch) | |
tree | 257f5ed86f8b593a8726249f042469b9eaa3f1cb /source/1.0/src/shflags | |
parent | a8cbe677c5163657e6a5a6f79454f079a0e38824 (diff) | |
download | shflags-0a4f16fc4e9bcffa9732c057877aa42e59f0a95b.tar.gz |
updated docs and unit test regarding the usage of boolean flags
Diffstat (limited to 'source/1.0/src/shflags')
-rw-r--r-- | source/1.0/src/shflags | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/source/1.0/src/shflags b/source/1.0/src/shflags index 814f450..371bf3e 100644 --- a/source/1.0/src/shflags +++ b/source/1.0/src/shflags @@ -18,12 +18,10 @@ # # DEFINE_string: takes any input, and intreprets it as a string. # -# DEFINE_boolean: typically does not take any argument: say --myflag to set -# FLAGS_myflag to true, or --nomyflag to set FLAGS_myflag to false. -# Alternately, you can say -# --myflag=true or --myflag=t or --myflag=0 or -# --myflag=false or --myflag=f or --myflag=1 -# Passing an option has the same affect as passing the option once. +# DEFINE_boolean: does not take any arguments. Say --myflag to set +# FLAGS_myflag to true, or --nomyflag to set FLAGS_myflag to false. For short +# flags, passing the flag on the command-line negates the default value, i.e. +# if the default is true, passing the flag sets the value to false. # # DEFINE_float: takes an input and intreprets it as a floating point number. As # shell does not support floats per-se, the input is merely validated as |