diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 60dc2f18e31083a1ee0f37773c97b7620c9ad9ed..01c735120a5eeb5e8e4141d611042096e12d0a47 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -1290,7 +1290,11 @@ BAD:

If there is a need for complex string concatenations, avoid using the usual sequence of malloc/strcpy/strcat/snprintf functions and - make use of the virBuffer API described in virbuffer.h + make use of either the + GString + type from GLib or the virBuffer API. + If formatting XML or QEMU command line is needed, use the virBuffer + API described in virbuffer.h, since it has helper functions for those.

Typical usage is as follows:

@@ -1299,12 +1303,14 @@ BAD: char * somefunction(...) { - virBuffer buf = VIR_BUFFER_INITIALIZER; + g_auto(virBuffer) buf = VIR_BUFFER_INITIALIZER; ... virBufferAddLit(&buf, "<domain>\n"); virBufferAsprintf(&buf, " <memory>%d</memory>\n", memory); + if (some_error) + return NULL; /* g_auto will free the memory used so far */ ... virBufferAddLit(&buf, "</domain>\n"); @@ -1388,12 +1394,10 @@ BAD:

- When printing to a string, consider using virBuffer for - incremental allocations, virAsprintf for a one-shot allocation, - and snprintf for fixed-width buffers. Do not use sprintf, even - if you can prove the buffer won't overflow, since gnulib does - not provide the same portability guarantees for sprintf as it - does for snprintf. + When printing to a string, consider using GString or virBuffer for + incremental allocations, g_strdup_printf for a one-shot allocation, + and g_snprintf for fixed-width buffers. Only use g_sprintf, + if you can prove the buffer won't overflow.

Error message format