parse-options-cb: implement parse_opt_passthru()
[gitweb.git] / Documentation / technical / api-parse-options.txt
index 1f2db313122ccb18223f3be429620fa3385cec51..85d10abb041be5d0ee146a4bca6cc4048f61dfa1 100644 (file)
@@ -212,6 +212,13 @@ There are some macros to easily define options:
        Use it to hide deprecated options that are still to be recognized
        and ignored silently.
 
+`OPT_PASSTHRU(short, long, &char_var, arg_str, description, flags)`::
+       Introduce an option that will be reconstructed into a char* string,
+       which must be initialized to NULL. This is useful when you need to
+       pass the command-line option to another command. Any previous value
+       will be overwritten, so this should only be used for options where
+       the last one specified on the command line wins.
+
 
 The last element of the array must be `OPT_END()`.