gmain: equivocate a bit on _set_ready_time()

Since this is a new API this cycle it's a good time to add a doc comment
explicitly declaring that a confusing issue that could be resolved
either way has no specific defined behaviour.

This may allow us some additional freedom in future GMainContext work or
we may decide that one behaviour is more desirable than the other.

diff --git a/glib/gmain.c b/glib/gmain.c
index 9f9eccc4c2db4be23de1d6857a58531e3648d977..68a7f8e81bdaf6a60d13e116f71f76ee9be7ca47 100644 (file)
--- a/glib/gmain.c
+++ b/glib/gmain.c
@@ -1735,6 +1735,12 @@ g_source_get_priority (GSource *source)
  * Dispatching the source does not reset the ready time.  You should do
  * so yourself, from the source dispatch function.
  *
+ * Note that if you have a pair of sources where the ready time of one
+ * suggests that it will be delivered first but the priority for the
+ * other suggests that it would be delivered first, and the ready time
+ * for both sources is reached during the same main context iteration
+ * then the order of dispatch is undefined.
+ *
  * Since: 2.36
  **/
 void