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 767215 - GCC version number is interpreted as start of a list in docs for g_io_channel_win32_new_fd()
GCC version number is interpreted as start of a list in docs for g_io_channel...
Status: RESOLVED FIXED
Product: glib
Classification: Platform
Component: docs
2.50.x
Other All
: Normal minor
: ---
Assigned To: gtkdev
gtkdev
Depends on:
Blocks:
 
 
Reported: 2016-06-03 18:03 UTC by Christian Stadelmann
Modified: 2017-10-05 13:50 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Christian Stadelmann 2016-06-03 18:03:42 UTC
In [1] glib/giowin32.c, documentation for g_io_channel_win32_new_fd() looks like this:

/**
 * g_io_channel_win32_new_fd:
 * @fd: a C library file descriptor.
[…]
 * build code that would use msvcrt.dll. The last Microsoft compiler
 * version that supported using msvcrt.dll as the C runtime was version
 * 6. The GNU compiler and toolchain for Windows, also known as Mingw,
 * fully supports msvcrt.dll.
 *
[…]
 *
 * This function is available only in GLib on Windows.
 *
 * Returns: a new #GIOChannel.
 **/

From that, both yelp and the online web documentation interpret "6." to be an item of a numbered list, indenting the line and putting a paragraph around it. [2].

I don't know who's to blame (gtk-doc or glib documentation). Feel free to reassign since you probably know better.

Affected version:
glib 2.48.1 and master as of 2016-06-03

[1] https://git.gnome.org/browse/glib/tree/glib/giowin32.c#n2063
[2] https://developer.gnome.org/glib/unstable/glib-IO-Channels.html#g-io-channel-win32-new-fd and https://developer.gnome.org/glib/stable/glib-IO-Channels.html#g-io-channel-win32-new-fd
Comment 1 Christian Stadelmann 2016-09-28 14:13:12 UTC
Affects 2.50.x and unstable/master docs.
Comment 2 Philip Withnall 2017-10-05 13:50:37 UTC
Fixed by rewrapping the line, thanks.