luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-08 10:14:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Expand documentation about D-Bus GUIDs

Browse Source 
Clarify that the terms ‘GUID’ and ‘UUID’ are used interchangeably in the
context of D-Bus, and that neither of them are an RFC 4122 UUID.

Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
This commit is contained in:
Philip Withnall
2021-06-10 12:36:25 +01:00
parent 71edc3ffe1
commit c794261a40
3 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
gio/gdbusconnection.c
View File

@@ -902,6 +902,15 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* of the other peer here after the connection has been successfully * of the other peer here after the connection has been successfully
* initialized. * initialized.
* *
* Note that the
* [D-Bus specification](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses)
* uses the term ‘UUID’ to refer to this, whereas GLib consistently uses the
* term ‘GUID’ for historical reasons.
*
* Despite its name, the format of #GDBusConnection:guid does not follow
* [RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122) or the Microsoft
* GUID format.
*
* Since: 2.26 * Since: 2.26
*/ */
g_object_class_install_property (gobject_class, g_object_class_install_property (gobject_class,

4
gio/gdbusserver.c
View File

@@ -320,7 +320,9 @@ g_dbus_server_class_init (GDBusServerClass *klass)
/** /**
* GDBusServer:guid: * GDBusServer:guid:
* *
* The guid of the server. * The GUID of the server.
*
* See #GDBusConnection:guid for more details.
* *
* Since: 2.26 * Since: 2.26
*/ */

14
gio/gdbusutils.c
View File

@@ -280,8 +280,14 @@ g_dbus_is_interface_name (const gchar *string)
* Generate a D-Bus GUID that can be used with * Generate a D-Bus GUID that can be used with
* e.g. g_dbus_connection_new(). * e.g. g_dbus_connection_new().
* *
* See the D-Bus specification regarding what strings are valid D-Bus * See the
* GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). * [D-Bus specification](https://dbus.freedesktop.org/doc/dbus-specification.html#uuids)
* regarding what strings are valid D-Bus GUIDs. The specification refers to
* these as ‘UUIDs’ whereas GLib (for historical reasons) refers to them as
* ‘GUIDs’. The terms are interchangeable.
*
* Note that D-Bus GUIDs do not follow
* [RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122).
* *
* Returns: A valid D-Bus GUID. Free with g_free(). * Returns: A valid D-Bus GUID. Free with g_free().
* *
@@ -317,8 +323,8 @@ g_dbus_generate_guid (void)
* *
* Checks if @string is a D-Bus GUID. * Checks if @string is a D-Bus GUID.
* *
* See the D-Bus specification regarding what strings are valid D-Bus * See the documentation for g_dbus_generate_guid() for more information about
* GUID (for example, D-Bus GUIDs are not RFC-4122 compliant). * the format of a GUID.
* *
* Returns: %TRUE if @string is a guid, %FALSE otherwise. * Returns: %TRUE if @string is a guid, %FALSE otherwise.
* *