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