[libvirt] [PATCH 03/12] util: buffer: Clarify scope of the escape operation in virBufferEscape

[Peter Krempa]

The escaping is applied only to the string, not the formating 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 52ffa08..30a4183 100644
--- a/src/util/virbuffer.c
+++ b/src/util/virbuffer.c
@@ -506,8 +506,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,
-- 
2.1.0