OSDN Git Service

api-parse-options.txt: document "no-" for non-boolean options
authorMichael Haggerty <mhagger@alum.mit.edu>
Thu, 18 Apr 2013 07:46:35 +0000 (09:46 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 18 Apr 2013 16:30:28 +0000 (09:30 -0700)
Document that the "no-" prefix can also be used for non-boolean
options.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-parse-options.txt

index 3062389..facc8c8 100644 (file)
@@ -41,6 +41,8 @@ The parse-options API allows:
 * Boolean long options can be 'negated' (or 'unset') by prepending
   `no-`, e.g. `--no-abbrev` instead of `--abbrev`. Conversely,
   options that begin with `no-` can be 'negated' by removing it.
+  Other long options can be unset (e.g., set string to NULL, set
+  integer to 0) by prepending `no-`.
 
 * Options and non-option arguments can clearly be separated using the `--`
   option, e.g. `-a -b --option -- --this-is-a-file` indicates that