perf tools: Document the fact that parse_options*() may exit
authorJosh Poimboeuf <jpoimboe@redhat.com>
Tue, 15 Dec 2015 15:39:34 +0000 (09:39 -0600)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Wed, 16 Dec 2015 19:16:49 +0000 (16:16 -0300)
commit24a88bdd05d5de32f3a56a4dcc5070c97d4a514f
tree59e0f3d5d3a829e415b22d9a5ab7ab0df42ed104
parentce99091730c92bf560712baa0696ea5a461b1fe8
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