opt: spelling fixes.

[ccan] / ccan / opt / opt.h

diff --git a/ccan/opt/opt.h b/ccan/opt/opt.h
index 7d7bc571fc2363f40241497297bcdc32ff5f6716..15699e1c916952b391352060a192b166b9abbfaa 100644 (file)
--- a/ccan/opt/opt.h
+++ b/ccan/opt/opt.h
@@ -6,8 +6,8 @@
 /* You can use this directly to build tables, but the macros will ensure
  * consistency and type safety. */
 enum opt_type {
-       OPT_NOARG = 1,          /* -f/--foo */
-       OPT_HASARG = 2,         /* -f arg/--foo=arg/--foo arg */
+       OPT_NOARG = 1,          /* -f|--foo */
+       OPT_HASARG = 2,         /* -f arg|--foo=arg|--foo arg */
        OPT_SUBTABLE = 4,       /* Actually, longopt points to a subtable... */
        OPT_END = 8,            /* End of the table. */
 };
@@ -16,7 +16,7 @@ enum opt_type {
 #define OPT_SHOW_LEN 80
 
 struct opt_table {
-       const char *names; /* slash-separated names, --longopt or -s */
+       const char *names; /* pipe-separated names, --longopt or -s */
        enum opt_type type;
        char *(*cb)(void *arg); /* OPT_NOARG */
        char *(*cb_arg)(const char *optarg, void *arg); /* OPT_HASARG */
@@ -27,12 +27,12 @@ struct opt_table {
 
 /**
  * OPT_WITHOUT_ARG() - macro for initializing an opt_table entry (without arg)
- * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar".
+ * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
  * @cb: the callback when the option is found.
  * @arg: the argument to hand to @cb.
  * @desc: the description for opt_usage(), or opt_hidden.
  *
- * This is a typesafe wrapper for intializing a struct opt_table.  The callback
+ * This is a typesafe wrapper for initializing a struct opt_table.  The callback
  * of type "char *cb(type *)", "char *cb(const type *)" or "char *cb(void *)",
  * where "type" is the type of the @arg argument.
  *
@@ -41,8 +41,8 @@ struct opt_table {
  * string and return false.
  *
  * Any number of equivalent short or long options can be listed in @names,
- * separated by '/'.  Short options are a single hyphen followed by a single
- * character, long options are two hypens followed by one or more characters.
+ * separated by '|'.  Short options are a single hyphen followed by a single
+ * character, long options are two hyphens followed by one or more characters.
  *
  * See Also:
  *     OPT_WITH_ARG()
@@ -52,13 +52,13 @@ struct opt_table {
 
 /**
  * OPT_WITH_ARG() - macro for initializing long and short option (with arg)
- * @names: the option names eg. "--foo=<arg>", "-f" or "-f/--foo <arg>".
+ * @names: the option names eg. "--foo=<arg>", "-f" or "-f|--foo <arg>".
  * @cb: the callback when the option is found (along with <arg>).
  * @show: the callback to print the value in get_usage (or NULL)
  * @arg: the argument to hand to @cb and @show
  * @desc: the description for opt_usage(), or opt_hidden.
  *
- * This is a typesafe wrapper for intializing a struct opt_table.  The callback
+ * This is a typesafe wrapper for initializing a struct opt_table.  The callback
  * is of type "char *cb(const char *, type *)",
  * "char *cb(const char *, const type *)" or "char *cb(const char *, void *)",
  * where "type" is the type of the @arg argument.  The first argument to the
@@ -70,8 +70,8 @@ struct opt_table {
  * nul-terminate that buffer.
  *
  * Any number of equivalent short or long options can be listed in @names,
- * separated by '/'.  Short options are a single hyphen followed by a single
- * character, long options are two hypens followed by one or more characters.
+ * separated by '|'.  Short options are a single hyphen followed by a single
+ * character, long options are two hyphens followed by one or more characters.
  * A space or equals in @names is ignored for parsing, and only used
  * for printing the usage.
  *
@@ -128,10 +128,10 @@ void opt_register_table(const struct opt_table table[], const char *desc);
 
 /**
  * opt_register_noarg - register an option with no arguments
- * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar".
+ * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
  * @cb: the callback when the option is found.
  * @arg: the argument to hand to @cb.
- * @desc: the verbose desction of the option (for opt_usage()), or NULL.
+ * @desc: the verbose description of the option (for opt_usage()), or NULL.
  *
  * This is used for registering a single commandline option which takes
  * no argument.
@@ -149,11 +149,11 @@ void opt_register_table(const struct opt_table table[], const char *desc);
 
 /**
  * opt_register_arg - register an option with an arguments
- * @names: the names of the option eg. "--foo", "-f" or "--foo/-f/--foobar".
+ * @names: the names of the option eg. "--foo", "-f" or "--foo|-f|--foobar".
  * @cb: the callback when the option is found.
  * @show: the callback to print the value in get_usage (or NULL)
  * @arg: the argument to hand to @cb.
- * @desc: the verbose desction of the option (for opt_usage()), or NULL.
+ * @desc: the verbose description of the option (for opt_usage()), or NULL.
  *
  * This is used for registering a single commandline option which takes
  * an argument.
@@ -172,7 +172,7 @@ void opt_register_table(const struct opt_table table[], const char *desc);
  *     errx(1, "BOOM! %s", optarg);
  * }
  * ...
- *     opt_register_arg("--explode/--boom", explode, NULL, NULL, opt_hidden);
+ *     opt_register_arg("--explode|--boom", explode, NULL, NULL, opt_hidden);
  */
 #define opt_register_arg(names, cb, show, arg, desc)                   \
        _opt_register((names), OPT_CB_ARG((cb), (show), (arg)), (desc))
@@ -298,7 +298,7 @@ char *opt_usage_and_exit(const char *extra);
 /* Resolves to the four parameters for non-arg callbacks. */
 #define OPT_CB_NOARG(cb, arg)                          \
        OPT_NOARG,                                      \
-       cast_if_any(char *(*)(void *), (cb), &*(cb),    \
+       cast_if_any(char *(*)(void *), (cb), (cb)+0,    \
                    char *(*)(typeof(*(arg))*),         \
                    char *(*)(const typeof(*(arg))*),   \
                    char *(*)(const void *)),           \
@@ -307,11 +307,11 @@ char *opt_usage_and_exit(const char *extra);
 /* Resolves to the four parameters for arg callbacks. */
 #define OPT_CB_ARG(cb, show, arg)                                      \
        OPT_HASARG, NULL,                                               \
-       cast_if_any(char *(*)(const char *,void *), (cb), &*(cb),       \
+       cast_if_any(char *(*)(const char *,void *), (cb), (cb)+0,       \
                    char *(*)(const char *, typeof(*(arg))*),           \
                    char *(*)(const char *, const typeof(*(arg))*),     \
                    char *(*)(const char *, const void *)),             \
-       cast_if_type(void (*)(char buf[], const void *), (show), &*(show), \
+       cast_if_type(void (*)(char buf[], const void *), (show), (show)+0, \
                     void (*)(char buf[], const typeof(*(arg))*)),      \
        (arg)