Skip to content

Commit 7f6263c

Browse files
committed
Update out of date documentation for opal_cmd_line_create()
Signed-off-by: Christoph Niethammer <niethammer@hlrs.de>
1 parent f9c42c9 commit 7f6263c

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

opal/util/cmd_line.h

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ BEGIN_C_DECLS
195195
OPAL_CMD_LINE_OTYPE_DVM,
196196
OPAL_CMD_LINE_OTYPE_UNSUPPORTED,
197197
OPAL_CMD_LINE_OTYPE_PARSABLE,
198-
OPAL_CMD_LINE_OTYPE_NULL
198+
OPAL_CMD_LINE_OTYPE_NULL /* include in full help only */
199199
};
200200
/**
201201
* \internal
@@ -286,16 +286,17 @@ BEGIN_C_DECLS
286286
*
287287
* \code
288288
* opal_cmd_line_init_t cmd_line_init[] = {
289-
* { NULL, NULL, NULL, 'h', NULL, "help", 0,
289+
* { NULL, 'h', NULL, "help", 0,
290290
* &orterun_globals.help, OPAL_CMD_LINE_TYPE_BOOL,
291-
* "This help message" },
291+
* "This help message", OPAL_CMD_LINE_OTYPE_GENERAL },
292292
*
293-
* { NULL, NULL, NULL, '\0', NULL, "wd", 1,
293+
* { NULL, '\0', NULL, "wd", 1,
294294
* &orterun_globals.wd, OPAL_CMD_LINE_TYPE_STRING,
295-
* "Set the working directory of the started processes" },
295+
* "Set the working directory of the started processes",
296+
* OPAL_CMD_LINE_OTYPE_LAUNCH },
296297
*
297-
* { NULL, NULL, NULL, '\0', NULL, NULL, 0,
298-
* NULL, OPAL_CMD_LINE_TYPE_NULL, NULL }
298+
* { NULL, '\0', NULL, NULL, 0,
299+
* NULL, OPAL_CMD_LINE_TYPE_NULL, NULL, OPAL_CMD_LINE_OTYPE_NULL }
299300
* };
300301
* \endcode
301302
*/

0 commit comments

Comments
 (0)