From: Ján Tomko <jtomko@redhat.com>
Date: Wed, 16 Oct 2019 13:58:28 +0000 (+0200)
Subject: docs: hacking: separate section about already deleted macros
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=e4943fce3be4dbb293f17c0c75f283461869ea5a;p=libvirt.git

docs: hacking: separate section about already deleted macros

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>
---

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index de450b7cde..92826c5d44 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -1029,6 +1029,15 @@ BAD:
         instead. Don't use g_vasprintf unless having the string length
         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>
       <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
@@ -1051,10 +1060,6 @@ BAD:
       <dd>The GLib macros g_autoptr and G_DEFINE_AUTOPTR_CLEANUP_FUNC
         should be used to manage autoclean of virObject classes.
         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>
 
     <h2><a id="file_handling">File handling</a></h2>