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