diff options
| author | Philip Withnall <pwithnall@endlessos.org> | 2020-11-17 10:15:15 +0000 |
|---|---|---|
| committer | Philip Withnall <pwithnall@endlessos.org> | 2020-11-20 14:41:07 +0000 |
| commit | 83e48d8ac1fee98059e2305d8909dca26190bddc (patch) | |
| tree | c45181680ac1a9e61bba457c0f828075c44c2439 /gio | |
| parent | 7d417f8406b8fa32a25659120738d22be6a1b482 (diff) | |
| download | glib-83e48d8ac1fee98059e2305d8909dca26190bddc.tar.gz | |
docs: Document not to use `volatile` qualifiers
Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
Fixes: #600
Diffstat (limited to 'gio')
| -rw-r--r-- | gio/gdbusconnection.c | 12 | ||||
| -rw-r--r-- | gio/gdbuserror.c | 3 |
2 files changed, 12 insertions, 3 deletions
diff --git a/gio/gdbusconnection.c b/gio/gdbusconnection.c index 91c365e80..65939a4d2 100644 --- a/gio/gdbusconnection.c +++ b/gio/gdbusconnection.c @@ -1708,7 +1708,9 @@ g_dbus_connection_send_message_unlocked (GDBusConnection *connection, * will be assigned by @connection and set on @message via * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the * serial number used will be written to this location prior to - * submitting the message to the underlying transport. + * submitting the message to the underlying transport. While it has a `volatile` + * qualifier, this is a historical artifact and the argument passed to it should + * not be `volatile`. * * If @connection is closed then the operation will fail with * %G_IO_ERROR_CLOSED. If @message is not well-formed, @@ -1979,7 +1981,9 @@ g_dbus_connection_send_message_with_reply_unlocked (GDBusConnection *connect * will be assigned by @connection and set on @message via * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the * serial number used will be written to this location prior to - * submitting the message to the underlying transport. + * submitting the message to the underlying transport. While it has a `volatile` + * qualifier, this is a historical artifact and the argument passed to it should + * not be `volatile`. * * If @connection is closed then the operation will fail with * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will @@ -2105,7 +2109,9 @@ send_message_with_reply_sync_cb (GDBusConnection *connection, * will be assigned by @connection and set on @message via * g_dbus_message_set_serial(). If @out_serial is not %NULL, then the * serial number used will be written to this location prior to - * submitting the message to the underlying transport. + * submitting the message to the underlying transport. While it has a `volatile` + * qualifier, this is a historical artifact and the argument passed to it should + * not be `volatile`. * * If @connection is closed then the operation will fail with * %G_IO_ERROR_CLOSED. If @cancellable is canceled, the operation will diff --git a/gio/gdbuserror.c b/gio/gdbuserror.c index b03a33f27..4ad97bb6e 100644 --- a/gio/gdbuserror.c +++ b/gio/gdbuserror.c @@ -177,6 +177,9 @@ g_dbus_error_quark (void) * * Helper function for associating a #GError error domain with D-Bus error names. * + * While @quark_volatile has a `volatile` qualifier, this is a historical + * artifact and the argument passed to it should not be `volatile`. + * * Since: 2.26 */ void |