README.in

   1 General Information
   2 ===================
   3
   4 This is GLib version @GLIB_VERSION@. GLib is the low-level core
   5 library that forms the basis for projects such as GTK+ and GNOME. It
   6 provides data structure handling for C, portability wrappers, and
   7 interfaces for such runtime functionality as an event loop, threads,
   8 dynamic loading, and an object system.
   9
  10 The official ftp site is:
  11   ftp://ftp.gtk.org/pub/gtk
  12
  13 The official web site is:
  14   http://www.gtk.org/
  15
  16 Information about mailing lists can be found at
  17   http://www.gtk.org/mailinglists.html
  18
  19 To subscribe: mail -s subscribe gtk-list-request@gnome.org < /dev/null
  20 (Send mail to gtk-list-request@gnome.org with the subject "subscribe")
  21
  22 Installation
  23 ============
  24
  25 See the file 'INSTALL'
  26
  27 Notes about GLib 2.10
  28 =====================
  29
  30 * The functions g_snprintf() and g_vsnprintf() have been removed from
  31   the gprintf.h header, since they are already declared in glib.h. This
  32   doesn't break documented use of gprintf.h, but people have been known
  33   to include gprintf.h without including glib.h.
  34
  35 * The Unicode support has been updated to Unicode 4.1. This adds several
  36   new members to the GUnicodeBreakType enumeration.
  37
  38 * The support for Solaris threads has been retired. Solaris has provided
  39   POSIX threads for long enough now to have them available on every
  40   Solaris platform.
  41
  42
  43 Notes about GLib 2.6.0
  44 ======================
  45
  46 * GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
  47   on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
  48   returning or accepting pathnames have been changed to expect
  49   filenames in this encoding, and the common POSIX functions dealing
  50   with pathnames have been wrapped. These wrappers are declared in the
  51   header <glib/gstdio.h> which must be included explicitly; it is not
  52   included through <glib.h>.
  53
  54   On current (NT-based) Windows versions, where the on-disk file names
  55   are Unicode, these wrappers use the wide-character API in the C
  56   library. Thus applications can handle file names containing any
  57   Unicode characters through GLib's own API and its POSIX wrappers,
  58   not just file names restricted to characters in the system codepage.
  59
  60   To keep binary compatibility with applications compiled against
  61   older versions of GLib, the Windows DLL still provides entry points
  62   with the old semantics using the old names, and applications
  63   compiled against GLib 2.6 will actually use new names for the
  64   functions. This is transparent to the programmer.
  65
  66   When compiling against GLib 2.6, applications intended to be
  67   portable to Windows must take the UTF-8 file name encoding into
  68   consideration, and use the gstdio wrappers to access files whose
  69   names have been constructed from strings returned from GLib.
  70
  71 * Likewise, g_get_user_name() and g_get_real_name() have been changed
  72   to return UTF-8 on Windows, while keeping the old semantics for
  73   applications compiled against older versions of GLib.
  74
  75 * The GLib uses an '_' prefix to indicate private symbols that
  76   must not be used by applications. On some platforms, symbols beginning
  77   with prefixes such as _g will be exported from the library, on others not.
  78   In no case can applications use these private symbols. In addition to that,
  79   GLib+ 2.6 makes several symbols private which were not in any installed
  80   header files and were never intended to be exported.
  81
  82 * To reduce code size and improve efficiency, GLib, when compiled
  83   with the GNU toolchain, has separate internal and external entry
  84   points for exported functions. The internal names, which begin with
  85   IA__, may be seen when debugging a GLib program.
  86
  87 * On Windows, GLib no longer opens a console window when printing
  88   warning messages if stdout or stderr are invalid, as they are in
  89   "Windows subsystem" (GUI) applications. Simply redirect stdout or
  90   stderr if you need to see them.
  91
  92 * The child watch functionality tends to reveal a bug in many
  93   thread implementations (in particular the older LinuxThreads
  94   implementation on Linux) where it's not possible to call waitpid()
  95   for a child created in a different thread. For this reason, for
  96   maximum portability, you should structure your code to fork all
  97   child processes that you want to wait for from the main thread.
  98
  99 * A problem was recently discovered with g_signal_connect_object();
 100   it doesn't actually disconnect the signal handler once the object being
 101   connected to dies, just disables it. See the API docs for the function
 102   for further details and the correct workaround that will continue to
 103   work with future versions of GLib.
 104
 105 How to report bugs
 106 ==================
 107
 108 Bugs should be reported to the GNOME bug tracking system.
 109 (http://bugzilla.gnome.org, product glib.) You will need
 110 to create an account for yourself.
 111
 112 In the bug report please include:
 113
 114 * Information about your system. For instance:
 115
 116    - What operating system and version
 117    - For Linux, what version of the C library
 118
 119   And anything else you think is relevant.
 120
 121 * How to reproduce the bug.
 122
 123   If you can reproduce it with one of the test programs that are built
 124   in the tests/ subdirectory, that will be most convenient.  Otherwise,
 125   please include a short test program that exhibits the behavior.
 126   As a last resort, you can also provide a pointer to a larger piece
 127   of software that can be downloaded.
 128
 129 * If the bug was a crash, the exact text that was printed out
 130   when the crash occured.
 131
 132 * Further information such as stack traces may be useful, but
 133   is not necessary.
 134
 135 Patches
 136 =======
 137
 138 Patches should also be submitted to bugzilla.gnome.org. If the
 139 patch fixes an existing bug, add the patch as an attachment
 140 to that bug report.
 141
 142 Otherwise, enter a new bug report that describes the patch,
 143 and attach the patch to that bug report.
 144
 145 Bug reports containing patches should include the PATCH keyword
 146 in their keyword fields. If the patch adds to or changes the GLib
 147 programming interface, the API keyword should also be included.
 148
 149 Patches should be in unified diff form. (The -u option to GNU
 150 diff.)