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 747927 - Documentation: various small improvements
Documentation: various small improvements
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.44.x
Other Linux
: Normal enhancement
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2015-04-15 14:34 UTC by Sébastien Wilmet
Modified: 2016-01-28 19:36 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: better documentation for g_file_info_copy_into() (1.35 KB, patch)
2015-04-15 14:35 UTC, Sébastien Wilmet
committed Details | Review
docs: improve doc of g_file_info_list_attributes() (862 bytes, patch)
2015-04-15 14:35 UTC, Sébastien Wilmet
committed Details | Review
docs: GRegex: @start_position is in bytes (3.87 KB, patch)
2015-04-15 14:35 UTC, Sébastien Wilmet
committed Details | Review

Description Sébastien Wilmet 2015-04-15 14:34:47 UTC
See the attached patches.
Comment 1 Sébastien Wilmet 2015-04-15 14:35:28 UTC
Created attachment 301641 [details] [review]
docs: better documentation for g_file_info_copy_into()

The documentation of g_file_info_copy_into() was misleading. The
attributes are not just copied, @dest_info is also cleared at the
beginning. So any previously set attributes in @dest_info are lost.

There was a bug in gedit about this function, where some metadata were
not saved. So it might make sense to change the implementation to not
clear @dest_info, and copy one by one the attributes from @src_info to
@dest_info.
Comment 2 Sébastien Wilmet 2015-04-15 14:35:35 UTC
Created attachment 301642 [details] [review]
docs: improve doc of g_file_info_list_attributes()

The name_space can be NULL.
Comment 3 Sébastien Wilmet 2015-04-15 14:35:42 UTC
Created attachment 301643 [details] [review]
docs: GRegex: @start_position is in bytes

The start_position arguments are passed to pcre_exec() as the
startoffset, which is in bytes (not characters).

I had recently a doubt about this, so it's better to document it.
Comment 4 Sébastien Wilmet 2015-10-07 15:18:23 UTC
Can someone review the above patches?
Comment 5 Sébastien Wilmet 2016-01-28 17:54:05 UTC
Comment on attachment 301642 [details] [review]
docs: improve doc of g_file_info_list_attributes()

Pushed to the master branch since it's a trivial patch and I got no feedbacks after asking one time on IRC and one more time here…
Comment 6 Sébastien Wilmet 2016-01-28 17:55:29 UTC
Comment on attachment 301643 [details] [review]
docs: GRegex: @start_position is in bytes

Also pushed, trivial patch.

There is one remaining less trivial patch to review, and which is quite important to avoid bugs in applications…
Comment 7 Matthias Clasen 2016-01-28 18:41:16 UTC
Review of attachment 301641 [details] [review]:

sure
Comment 8 Matthias Clasen 2016-01-28 18:43:34 UTC
(In reply to Sébastien Wilmet from comment #5)
> Comment on attachment 301642 [details] [review] [review]
> docs: improve doc of g_file_info_list_attributes()
> 
> Pushed to the master branch since it's a trivial patch and I got no
> feedbacks after asking one time on IRC and one more time here…

Here is some (late) feedback: the subject line would have better talked about annotations, since this is not really about docs.
Comment 9 Sébastien Wilmet 2016-01-28 19:36:04 UTC
Attachment 301641 [details] pushed as 95dd373 - docs: better documentation for g_file_info_copy_into()