1
0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-26 03:21:44 +03:00

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.
This commit is contained in:
Peter Krempa 2014-11-11 17:23:49 +01:00
parent e650f30b93
commit 7be41e787d

View File

@ -505,8 +505,9 @@ virBufferEscapeSexpr(virBufferPtr buf,
* @str: the string argument which needs to be escaped * @str: the string argument which needs to be escaped
* *
* Do a formatted print with a single string to a buffer. Any characters * 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 * in the provided list that are contained in @str are escaped with the
* may be applied. * given escape. Escaping is not applied to characters specified in @format.
* Auto indentation may be applied.
*/ */
void void
virBufferEscape(virBufferPtr buf, char escape, const char *toescape, virBufferEscape(virBufferPtr buf, char escape, const char *toescape,