After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 744722 - docs: Expand introduction to mention using async calls over sync ones
docs: Expand introduction to mention using async calls over sync ones
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: gio
unspecified
Other All
: Normal normal
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2015-02-18 17:11 UTC by Philip Withnall
Modified: 2015-03-03 18:28 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: Expand introduction to mention using async calls over sync ones (4.48 KB, patch)
2015-02-18 17:11 UTC, Philip Withnall
committed Details | Review

Description Philip Withnall 2015-02-18 17:11:06 UTC
As discussed on the mailing list: https://mail.gnome.org/archives/desktop-devel-list/2015-February/msg00126.html (and the rest of that thread).
Comment 1 Philip Withnall 2015-02-18 17:11:10 UTC
Created attachment 297119 [details] [review]
docs: Expand introduction to mention using async calls over sync ones

As discussed on the mailing list (see the whole thread):
    https://mail.gnome.org/archives/desktop-devel-list/2015-February/msg00126.html

Expand the GIO documentation introduction to talk a little about when to
use async and sync functions, and how the former should almost always be
preferred over the latter.

Link to this from the GFile documentation, which is an entry point for a
lot of async calls.
Comment 2 Allison Karlitskaya (desrt) 2015-03-02 22:17:14 UTC
Review of attachment 297119 [details] [review]:

One minor comment below, but otherwise it looks quite good.

::: docs/reference/gio/overview.xml
@@ +195,3 @@
+    <para>
+      Many GIO functions come in two versions: synchronous and asynchronous,
+      denoted by an <code>_async</code> suffix. It is important to use these

Might be worth mentioning that we have a bunch of APIs that work the davidz way: _sync() for the sync version and no suffix for the async one.
Comment 3 Philip Withnall 2015-03-03 18:28:31 UTC
Pushed with a short paragraph inserted to mention the _sync variants.

Related report which needs review: bug #745092.

Attachment 297119 [details] pushed as 4308149 - docs: Expand introduction to mention using async calls over sync ones