fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-02-01 06:50:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

glib-aux/trivial: update code comment for nm_g_idle_add()

Browse source
This commit is contained in:
Thomas Haller 2021-09-28 13:38:59 +02:00
parent 78c716cfaf
commit 81ed762d46
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/libnm-glib-aux/nm-shared-utils.h
View file

@ -1745,14 +1745,15 @@ nm_g_source_attach(GSource *source, GMainContext *context)
static inline void
nm_g_idle_add(GSourceFunc func, gpointer user_data)
{
/* g_idle_add() is discouraged because it relies on the guint source ids.
/* g_idle_add() is discouraged because it relies on the guint source IDs.
*
* Usually, you would want to use nm_g_idle_add_source() which returns a GSource*
* instance.
*
* However, if you don't care to ever call g_source_remove() on the source id, then
* g_idle_add() is fine. But our checkpatch script would complain about it. nm_g_idle_add(),
* is the solution because it intentionally ignores the guint source id. */
* However, if you don't care to ever call g_source_remove() on the source ID, then
* g_idle_add() is fine. But our checkpatch script would complain about it. In
* that case use nm_g_idle_add(), which makes it clear that you really want to
* use g_idle_add() and ignore the source ID. */
g_idle_add(func, user_data);
}