Comment explaining `need_save' argument to cmdline_process_param().

git-svn-id: svn://svn.tartarus.org/sgt/putty@4349 cda61777-01e9-0310-a592-d414129be87e

diff --git a/cmdline.c b/cmdline.c
index 2a05484..a67b013 100644 (file)
--- a/cmdline.c
+++ b/cmdline.c
@@ -111,6 +111,12 @@ static int cmdline_check_unavailable(int flag, char *p)
  * Process a standard command-line parameter. `p' is the parameter
  * in question; `value' is the subsequent element of argv, which
  * may or may not be required as an operand to the parameter.
+ * If `need_save' is 1, arguments which need to be saved as
+ * described at this top of this file are, for later execution;
+ * if 0, they are processed normally. (-1 is a special value used
+ * by pterm to count arguments for a preliminary pass through the
+ * argument list; it causes immediate return with an appropriate
+ * value with no action taken.)
  * Return value is 2 if both arguments were used; 1 if only p was
  * used; 0 if the parameter wasn't one we recognised; -2 if it
  * should have been 2 but value was NULL.