Code

Typo
[nagiosplug.git] / lib / extra_opts.h
index 25bfc6db1601699d99332778baf66cb6384cd947..4bb7b73b5155fcbe4f18f5c658597cd534f291ee 100644 (file)
@@ -8,12 +8,16 @@
 
 /* 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 and the new array and all its elements can be
- * freed with free();
+ * 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);
 
 #endif /* _EXTRA_OPTS_H_ */
+