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/mailing-lists.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.30
  28 =====================
  29
  30 * GObject includes a generic marshaller, g_cclosure_marshal_generic.
  31   To use it, simply specify NULL as the marshaller in g_signal_new().
  32   The generic marshaller is implemented with libffi, and consequently
  33   GObject depends on libffi now.
  34
  35 Notes about GLib 2.28
  36 =====================
  37
  38 * The GApplication API has changed compared to the version that was
  39   included in the 2.25 development snapshots. Existing users will need
  40   adjustments.
  41
  42 Notes about GLib 2.26
  43 =====================
  44
  45 * Nothing noteworthy.
  46
  47 Notes about GLib 2.24
  48 =====================
  49
  50 * It is now allowed to call g_thread_init(NULL) multiple times, and
  51   to call glib functions before g_thread_init(NULL) is called
  52   (although the later is mainly a change in docs as this worked before
  53   too). See the GThread reference documentation for the details.
  54
  55 * GObject now links to GThread and threads are enabled automatically
  56   when g_type_init() is called.
  57
  58 * GObject no longer allows to call g_object_set() on construct-only properties
  59   while an object is being initialized. If this behavior is needed, setting a
  60   custom constructor that just chains up will re-enable this functionality.
  61
  62 * GMappedFile on an empty file now returns NULL for the contents instead of
  63   returning an empty string. The documentation specifically states that code
  64   may not rely on nul-termination here so any breakage caused by this change
  65   is a bug in application code.
  66
  67 Notes about GLib 2.22
  68 =====================
  69
  70 * Repeated calls to g_simple_async_result_set_op_res_gpointer used
  71   to leak the data. This has been fixed to always call the provided
  72   destroy notify.
  73
  74 Notes about GLib 2.20
  75 =====================
  76
  77 * The functions for launching applications (e.g. g_app_info_launch() +
  78   friends) now passes a FUSE file:// URI if possible (requires gvfs
  79   with the FUSE daemon to be running and operational). With gvfs 2.26,
  80   FUSE file:// URIs will be mapped back to gio URIs in the GFile
  81   constructors. The intent of this change is to better integrate
  82   POSIX-only applications, see bug #528670 for the rationale.  The
  83   only user-visible change is when an application needs to examine an
  84   URI passed to it (e.g. as a positional parameter). Instead of
  85   looking at the given URI, the application will now need to look at
  86   the result of g_file_get_uri() after having constructed a GFile
  87   object with the given URI.
  88
  89 Notes about GLib 2.18
  90 =====================
  91
  92 * The recommended way of using GLib has always been to only include the
  93   toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
  94   generating an error when individual headers are directly included.
  95   To help with the transition, the enforcement is not turned on by
  96   default for GLib headers (it is turned on for GObject and GIO).
  97   To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
  98
  99 Notes about GLib 2.16
 100 =====================
 101
 102 * GLib now includes GIO, which adds optional dependencies against libattr
 103   and libselinux for extended attribute and SELinux support. Use
 104   --disable-xattr and --disable-selinux to build without these.
 105
 106 Notes about GLib 2.10
 107 =====================
 108
 109 * The functions g_snprintf() and g_vsnprintf() have been removed from
 110   the gprintf.h header, since they are already declared in glib.h. This
 111   doesn't break documented use of gprintf.h, but people have been known
 112   to include gprintf.h without including glib.h.
 113
 114 * The Unicode support has been updated to Unicode 4.1. This adds several
 115   new members to the GUnicodeBreakType enumeration.
 116
 117 * The support for Solaris threads has been retired. Solaris has provided
 118   POSIX threads for long enough now to have them available on every
 119   Solaris platform.
 120
 121 * 'make check' has been changed to validate translations by calling
 122   msgfmt with the -c option. As a result, it may fail on systems with
 123   older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
 124   'make check' will also fail on systems where the C compiler does not
 125   support ELF visibility attributes.
 126
 127 * The GMemChunk API has been deprecated in favour of a new 'slice
 128   allocator'. See the g_slice documentation for more details.
 129
 130 * A new type, GInitiallyUnowned, has been introduced, which is
 131   intended to serve as a common implementation of the 'floating reference'
 132   concept that is e.g. used by GtkObject. Note that changing the
 133   inheritance hierarchy of a type can cause problems for language
 134   bindings and other code which needs to work closely with the type
 135   system. Therefore, switching to GInitiallyUnowned should be done
 136   carefully. g_object_compat_control() has been added to GLib 2.8.5
 137   to help with the transition.
 138
 139 Notes about GLib 2.6.0
 140 ======================
 141
 142 * GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
 143   on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
 144   returning or accepting pathnames have been changed to expect
 145   filenames in this encoding, and the common POSIX functions dealing
 146   with pathnames have been wrapped. These wrappers are declared in the
 147   header <glib/gstdio.h> which must be included explicitly; it is not
 148   included through <glib.h>.
 149
 150   On current (NT-based) Windows versions, where the on-disk file names
 151   are Unicode, these wrappers use the wide-character API in the C
 152   library. Thus applications can handle file names containing any
 153   Unicode characters through GLib's own API and its POSIX wrappers,
 154   not just file names restricted to characters in the system codepage.
 155
 156   To keep binary compatibility with applications compiled against
 157   older versions of GLib, the Windows DLL still provides entry points
 158   with the old semantics using the old names, and applications
 159   compiled against GLib 2.6 will actually use new names for the
 160   functions. This is transparent to the programmer.
 161
 162   When compiling against GLib 2.6, applications intended to be
 163   portable to Windows must take the UTF-8 file name encoding into
 164   consideration, and use the gstdio wrappers to access files whose
 165   names have been constructed from strings returned from GLib.
 166
 167 * Likewise, g_get_user_name() and g_get_real_name() have been changed
 168   to return UTF-8 on Windows, while keeping the old semantics for
 169   applications compiled against older versions of GLib.
 170
 171 * The GLib uses an '_' prefix to indicate private symbols that
 172   must not be used by applications. On some platforms, symbols beginning
 173   with prefixes such as _g will be exported from the library, on others not.
 174   In no case can applications use these private symbols. In addition to that,
 175   GLib+ 2.6 makes several symbols private which were not in any installed
 176   header files and were never intended to be exported.
 177
 178 * To reduce code size and improve efficiency, GLib, when compiled
 179   with the GNU toolchain, has separate internal and external entry
 180   points for exported functions. The internal names, which begin with
 181   IA__, may be seen when debugging a GLib program.
 182
 183 * On Windows, GLib no longer opens a console window when printing
 184   warning messages if stdout or stderr are invalid, as they are in
 185   "Windows subsystem" (GUI) applications. Simply redirect stdout or
 186   stderr if you need to see them.
 187
 188 * The child watch functionality tends to reveal a bug in many
 189   thread implementations (in particular the older LinuxThreads
 190   implementation on Linux) where it's not possible to call waitpid()
 191   for a child created in a different thread. For this reason, for
 192   maximum portability, you should structure your code to fork all
 193   child processes that you want to wait for from the main thread.
 194
 195 * A problem was recently discovered with g_signal_connect_object();
 196   it doesn't actually disconnect the signal handler once the object being
 197   connected to dies, just disables it. See the API docs for the function
 198   for further details and the correct workaround that will continue to
 199   work with future versions of GLib.
 200
 201 How to report bugs
 202 ==================
 203
 204 Bugs should be reported to the GNOME bug tracking system.
 205 (http://bugzilla.gnome.org, product glib.) You will need
 206 to create an account for yourself.
 207
 208 In the bug report please include:
 209
 210 * Information about your system. For instance:
 211
 212    - What operating system and version
 213    - For Linux, what version of the C library
 214
 215   And anything else you think is relevant.
 216
 217 * How to reproduce the bug.
 218
 219   If you can reproduce it with one of the test programs that are built
 220   in the tests/ subdirectory, that will be most convenient.  Otherwise,
 221   please include a short test program that exhibits the behavior.
 222   As a last resort, you can also provide a pointer to a larger piece
 223   of software that can be downloaded.
 224
 225 * If the bug was a crash, the exact text that was printed out
 226   when the crash occured.
 227
 228 * Further information such as stack traces may be useful, but
 229   is not necessary.
 230
 231 Patches
 232 =======
 233
 234 Patches should also be submitted to bugzilla.gnome.org. If the
 235 patch fixes an existing bug, add the patch as an attachment
 236 to that bug report.
 237
 238 Otherwise, enter a new bug report that describes the patch,
 239 and attach the patch to that bug report.
 240
 241 Patches should be in unified diff form. (The -up option to GNUdiff.)