External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-03 11:35:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: hacking: separate section about already deleted macros

Browse Source 
Move the recently deleted libvirt macros into a separate section.

Signed-off-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Ján Tomko 2019-10-16 15:58:28 +02:00
parent 8e0c590c14
commit e4943fce3b
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/hacking.html.in
View File

@ -1029,6 +1029,15 @@ BAD:
instead. Don't use g_vasprintf unless having the string length instead. Don't use g_vasprintf unless having the string length
returned is unavoidable.</dd> returned is unavoidable.</dd>
<dt>virStrerror</dt>
<dd>The GLib <code>g_strerror()</code> function should be used instead,
which has a simpler calling convention as an added benefit.</dd>
</dl>
<p>
The following libvirt APIs have been deleted already:
</p>
<dl>
<dt>VIR_AUTOPTR, VIR_AUTOCLEAN, VIR_AUTOFREE</dt> <dt>VIR_AUTOPTR, VIR_AUTOCLEAN, VIR_AUTOFREE</dt>
<dd>The GLib macros g_autoptr, g_auto and g_autofree must be used <dd>The GLib macros g_autoptr, g_auto and g_autofree must be used
instead in all new code. In existing code, the GLib macros must instead in all new code. In existing code, the GLib macros must
@ -1051,10 +1060,6 @@ BAD:
<dd>The GLib macros g_autoptr and G_DEFINE_AUTOPTR_CLEANUP_FUNC <dd>The GLib macros g_autoptr and G_DEFINE_AUTOPTR_CLEANUP_FUNC
should be used to manage autoclean of virObject classes. should be used to manage autoclean of virObject classes.
This matches usage with GObject classes.</dd> This matches usage with GObject classes.</dd>
<dt>virStrerror</dt>
<dd>The GLib g_strerror() function should be used instead,
which has a simpler calling convention as an added benefit.</dd>
</dl> </dl>
<h2><a id="file_handling">File handling</a></h2> <h2><a id="file_handling">File handling</a></h2>