Messages in this thread Patch in this message | | | Date | Fri, 18 Dec 2015 00:52:40 -0800 | From | tip-bot for Josh Poimboeuf <> | Subject | [tip:perf/core] perf tools: Document the fact that parse_options* () may exit |
| |
Commit-ID: 24a88bdd05d5de32f3a56a4dcc5070c97d4a514f Gitweb: http://git.kernel.org/tip/24a88bdd05d5de32f3a56a4dcc5070c97d4a514f Author: Josh Poimboeuf <jpoimboe@redhat.com> AuthorDate: Tue, 15 Dec 2015 09:39:34 -0600 Committer: Arnaldo Carvalho de Melo <acme@redhat.com> CommitDate: Wed, 16 Dec 2015 16:16:49 -0300
perf tools: Document the fact that parse_options*() may exit
Generally, calling exit() from a library is bad practice. Eventually these functions might be redesigned so that they don't exit. For now, just document the fact that they do.
Signed-off-by: Josh Poimboeuf <jpoimboe@redhat.com> Cc: Jiri Olsa <jolsa@redhat.com> Cc: Namhyung Kim <namhyung@kernel.org> Cc: Peter Zijlstra <peterz@infradead.org> Link: http://lkml.kernel.org/r/97b1af06cc3b18dd0f49e655d6d659eaa64ecde5.1450193761.git.jpoimboe@redhat.com Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com> --- tools/perf/util/parse-options.h | 3 +++ 1 file changed, 3 insertions(+)
diff --git a/tools/perf/util/parse-options.h b/tools/perf/util/parse-options.h index 1231960..d1544069 100644 --- a/tools/perf/util/parse-options.h +++ b/tools/perf/util/parse-options.h @@ -152,6 +152,9 @@ struct option { /* parse_options() will filter out the processed options and leave the * non-option argments in argv[]. * Returns the number of arguments left in argv[]. + * + * NOTE: parse_options() and parse_options_subcommand() may call exit() in the + * case of an error (or for 'special' options like --list-cmds or --list-opts). */ extern int parse_options(int argc, const char **argv, const struct option *options,
| |