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 732357 - Docs: various fixes and improvements
Docs: various fixes and improvements
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.41.x
Other All
: Normal enhancement
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2014-06-27 19:01 UTC by Sébastien Wilmet
Modified: 2014-06-29 15:59 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
doc: various improvements (3.01 KB, patch)
2014-06-27 19:01 UTC, Sébastien Wilmet
accepted-commit_now Details | Review
doc: improve doc of g_file_equal() (1.01 KB, patch)
2014-06-27 19:01 UTC, Sébastien Wilmet
accepted-commit_now Details | Review

Description Sébastien Wilmet 2014-06-27 19:01:03 UTC
I'll attach two small commits, stay tuned.
Comment 1 Sébastien Wilmet 2014-06-27 19:01:38 UTC
Created attachment 279435 [details] [review]
doc: various improvements

- g_subprocess_launcher_spawn() and spawnv(): there is no other way
  AFAIK to create a GSubprocess from a launcher. So these
  functions are not "convenience helper".

- annotate optional arguments for g_shell_parse_argv().

- other trivial fix
Comment 2 Sébastien Wilmet 2014-06-27 19:01:41 UTC
Created attachment 279436 [details] [review]
doc: improve doc of g_file_equal()

A critical message is printed when a parameter of g_file_equal() is not
a GFile. When we read the documentation before this commit, we can think
that passing NULL or another type than GFile is allowed, but it is not
the case.

Another option is to allow NULL parameters. But for consistency with
e.g. g_str_equal(), it's probably better to keep the code as is.
Comment 3 Matthias Clasen 2014-06-28 23:50:55 UTC
Review of attachment 279435 [details] [review]:

looks correct, thanks
Comment 4 Matthias Clasen 2014-06-28 23:52:31 UTC
Review of attachment 279436 [details] [review]:

true
Comment 5 Sébastien Wilmet 2014-06-29 15:59:52 UTC
Both commits are pushed, thanks for the quick review.