From 7be41e787de5dc101f1fa6d21f3030aedbc1e12c Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Tue, 11 Nov 2014 17:23:49 +0100 Subject: [PATCH] util: buffer: Clarify scope of the escape operation in virBufferEscape The escaping is applied only to the string, not the format argument. State this fact in the docs. --- src/util/virbuffer.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/util/virbuffer.c b/src/util/virbuffer.c index 16a81e7df5..e94b35d1dc 100644 --- a/src/util/virbuffer.c +++ b/src/util/virbuffer.c @@ -505,8 +505,9 @@ virBufferEscapeSexpr(virBufferPtr buf, * @str: the string argument which needs to be escaped * * Do a formatted print with a single string to a buffer. Any characters - * in the provided list are escaped with the given escape. Auto indentation - * may be applied. + * in the provided list that are contained in @str are escaped with the + * given escape. Escaping is not applied to characters specified in @format. + * Auto indentation may be applied. */ void virBufferEscape(virBufferPtr buf, char escape, const char *toescape,