Re: [libvirt PATCH 1/2] docs: Convert existing tables to list-table

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, May 07, 2020 at 02:46:38PM +0200, Andrea Bolognani wrote:
> Signed-off-by: Andrea Bolognani <abologna@xxxxxxxxxx>
> ---
>  docs/coding-style.rst  |  53 +++++++++++-------
>  docs/glib-adoption.rst | 123 +++++++++++++++++++++++++++--------------
>  2 files changed, 114 insertions(+), 62 deletions(-)
> 

> diff --git a/docs/glib-adoption.rst b/docs/glib-adoption.rst
> index 62ddd7c61d..a5dca47f5e 100644
> --- a/docs/glib-adoption.rst
> +++ b/docs/glib-adoption.rst
> @@ -53,44 +53,85 @@ The following libvirt APIs have been deleted already:
>  ``VIR_STRDUP``, ``VIR_STRNDUP``
>     Prefer the GLib APIs ``g_strdup`` and ``g_strndup``.
>  
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| deleted version               | GLib version                         | Notes                                     |
> -+===============================+======================================+===========================================+
> -| ``VIR_AUTOPTR``               | ``g_autoptr``                        |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_AUTOCLEAN``             | ``g_auto``                           |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_AUTOFREE``              | ``g_autofree``                       | The GLib version does not use parentheses |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_AUTOUNREF``             | ``g_autoptr``                        | The cleanup function needs to be defined  |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_DEFINE_AUTOPTR_FUNC``   | ``G_DEFINE_AUTOPTR_CLEANUP_FUNC``    |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_DEFINE_AUTOCLEAN_FUNC`` | ``G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC`` |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_STEAL_PTR``             | ``g_steal_pointer``                  | ``a = f(&b)`` instead of ``f(a, b)``      |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_RETURN_PTR``            | ``return g_steal_pointer``           |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ARRAY_CARDINALITY``         | ``G_N_ELEMENTS``                     |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_FALLTHROUGH``     | ``G_GNUC_FALLTHROUGH``               |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_FMT_PRINTF``      | ``G_GNUC_PRINTF``                    |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_NOINLINE``        | ``G_GNUC_NO_INLINE``                 |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_NORETURN``        | ``G_GNUC_NORETURN``                  |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_RETURN_CHECK``    | ``G_GNUC_WARN_UNUSED_RESULT``        |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_SENTINEL``        | ``G_GNUC_NULL_TERMINATED``           |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``ATTRIBUTE_UNUSED``          | ``G_GNUC_UNUSED``                    |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_STRDUP``                | ``g_strdup``                         |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``VIR_STRNDUP``               | ``g_strndup``                        |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> -| ``virStrerror``               | ``g_strerror``                       |                                           |
> -+-------------------------------+--------------------------------------+-------------------------------------------+
> +.. list-table::
> +   :header-rows: 1
> +
> +   * - deleted version
> +     - GLib version
> +     - Notes
> +
> +   * - ``VIR_AUTOPTR``
> +     - ``g_autoptr``
> +     -
> +
> +   * - ``VIR_AUTOCLEAN``
> +     - ``g_auto``
> +     -
> +
> +   * - ``VIR_AUTOFREE``
> +     - ``g_autofree``
> +     - The GLib version does not use parentheses
> +
> +   * - ``VIR_AUTOUNREF``
> +     - ``g_autoptr``
> +     - The cleanup function needs to be defined
> +
> +   * - ``VIR_DEFINE_AUTOPTR_FUNC``
> +     - ``G_DEFINE_AUTOPTR_CLEANUP_FUNC``
> +     -
> +
> +   * - ``VIR_DEFINE_AUTOCLEAN_FUNC``
> +     - ``G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC``
> +     -
> +
> +   * - ``VIR_STEAL_PTR``
> +     - ``g_steal_pointer``
> +     - ``a = f(&b)`` instead of ``f(a, b)``
> +
> +   * - ``VIR_RETURN_PTR``
> +     - ``return g_steal_pointer``
> +     -
> +
> +   * - ``ARRAY_CARDINALITY``
> +     - ``G_N_ELEMENTS``
> +     -
> +
> +   * - ``ATTRIBUTE_FALLTHROUGH``
> +     - ``G_GNUC_FALLTHROUGH``
> +     -
> +
> +   * - ``ATTRIBUTE_FMT_PRINTF``
> +     - ``G_GNUC_PRINTF``
> +     -
> +
> +   * - ``ATTRIBUTE_NOINLINE``
> +     - ``G_GNUC_NO_INLINE``
> +     -
> +
> +   * - ``ATTRIBUTE_NORETURN``
> +     - ``G_GNUC_NORETURN``
> +     -
> +
> +   * - ``ATTRIBUTE_RETURN_CHECK``
> +     - ``G_GNUC_WARN_UNUSED_RESULT``
> +     -
> +
> +   * - ``ATTRIBUTE_SENTINEL``
> +     - ``G_GNUC_NULL_TERMINATED``
> +     -
> +
> +   * - ``ATTRIBUTE_UNUSED``
> +     - ``G_GNUC_UNUSED``
> +     -
> +
> +   * - ``VIR_STRDUP``
> +     - ``g_strdup``
> +     -
> +
> +   * - ``VIR_STRNDUP``
> +     - ``g_strndup``
> +     -
> +
> +   * - ``virStrerror``
> +     - ``g_strerror``
> +     -

I'm wondering how long we actually need to bother keeping this text,
given that it is talking about stuff we've already deleted.

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|





[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux