[libvirt] [PATCH v2 7/9] util: error: Improve docs for virErrorMsg

Clarify how @info is used and what the returned values look like. Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; Reviewed-by: Erik Skultety <eskultet(a)redhat.com&gt; --- src/util/virerror.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/util/virerror.c b/src/util/virerror.c index 1e7c8bdb90..03166d85d2 100644 --- a/src/util/virerror.c +++ b/src/util/virerror.c @@ -907,12 +907,14 @@ void virRaiseErrorObject(const char *filename, /** * virErrorMsg: * @error: the virErrorNumber - * @info: usually the first parameter string + * @info: additional info string * - * Internal routine to get the message associated to an error raised - * from the library + * Internal routine to get the message associated to @error raised + * from the library. * - * Returns the constant string associated to @error + * Returns a *printf format string which describes @error. The returned string + * contains exactly one '%s' modifier if @info is non-NULL, or no modifiers at + * all if @info is NULL. If @error is invalid NULL is returned. */ const char * virErrorMsg(virErrorNumber error, const char *info) -- 2.19.2