From: Ján Tomko <jtomko@redhat.com>
Date: Thu, 24 Sep 2020 12:15:52 +0000 (+0200)
Subject: docs: glib-adoption: add string arrays and objects
X-Git-Tag: v6.9.0-rc1~397
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c1f3a628d0e3a2a56c67f2f7109a7a0322c6f405;p=thirdparty%2Flibvirt.git

docs: glib-adoption: add string arrays and objects

Signed-off-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
---

diff --git a/docs/glib-adoption.rst b/docs/glib-adoption.rst
index 1cf5b9cf9b..f969ac80a1 100644
--- a/docs/glib-adoption.rst
+++ b/docs/glib-adoption.rst
@@ -36,3 +36,19 @@ Array operations
    the GLib types, ``GArray``, ``GPtrArray`` or ``GByteArray``.
    These all use a struct to track the array memory and size
    together and efficiently resize.
+
+String arrays
+   ``virStringList*``, ``virStringListCount*``
+
+   https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html
+
+   Prefer the NULL-terminated variant instead of storing the count
+   separately. Prefer ``g_str*v`` functions instead of their ``vir*``
+   counterparts. For use with ``g_auto`` GLib provides the ``GStrv`` type.
+
+Objects
+   ``virObject``
+
+   https://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html
+
+   Prefer ``GObject`` instead.