aboutsummaryrefslogtreecommitdiff
path: root/lib/extra_opts.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/extra_opts.h')
-rw-r--r--lib/extra_opts.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/extra_opts.h b/lib/extra_opts.h
index 0cb47fb1..4bb7b73b 100644
--- a/lib/extra_opts.h
+++ b/lib/extra_opts.h
@@ -8,11 +8,14 @@
/* np_extra_opts: Process the --extra-opts arguments and create a new argument
* array with ini-processed and argument-passed arguments together. The
- * ini-procesed arguments always come first (in the ord of --extra-opts
+ * ini-procesed arguments always come first (in the order of --extra-opts
* arguments). If no --extra-opts arguments are provided or returned nothing
* it returns **argv otherwise the new array is returned. --extra-opts are
* always removed from **argv. The original pointers from **argv are kept in
* the new array to preserve ability to overwrite arguments in processlist.
+ *
+ * The new array can be easily freed as long as a pointer to the original one
+ * is kept. See my_free() in lib/tests/test_opts1.c for an example.
*/
char **np_extra_opts(int *argc, char **argv, const char *plugin_name);