luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-31 12:53:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dbus-guids-docs' into 'main'

Browse Source 
docs: Expand documentation about D-Bus GUIDs

See merge request GNOME/glib!1812
This commit is contained in:
Philip Withnall 2021-06-10 12:27:29 +00:00
commit fa21de35c9
4 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gio/gdbusauth.c
View File

@ -960,7 +960,7 @@ _g_dbus_auth_run_server (GDBusAuth *auth,
g_set_error (error, g_set_error (error,
G_IO_ERROR, G_IO_ERROR,
G_IO_ERROR_FAILED, G_IO_ERROR_FAILED,
"The given guid '%s' is not valid", "The given GUID '%s' is not valid",
guid); guid);
goto out; goto out;
} }

11
gio/gdbusconnection.c
View File

@ -386,7 +386,7 @@ struct _GDBusConnection
*/ */
gchar *bus_unique_name; gchar *bus_unique_name;
/* The GUID returned by the other side if we authenticed as a client or /* The GUID returned by the other side if we authenticated as a client or
* the GUID to use if authenticating as a server. * the GUID to use if authenticating as a server.
* Read-only after initable_init(), so it may be read if you either * Read-only after initable_init(), so it may be read if you either
* hold @init_lock or check for initialization first. * hold @init_lock or check for initialization first.
@ -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
*/ */

16
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,10 +323,10 @@ 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.
* *
* Since: 2.26 * Since: 2.26
*/ */