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 download locations are:
  11   ftp://ftp.gtk.org/pub/glib
  12   http://download.gnome.org/sources/glib
  13
  14 The official web site is:
  15   http://www.gtk.org/
  16
  17 Information about mailing lists can be found at
  18   http://www.gtk.org/mailing-lists.php
  19
  20 To subscribe, send mail to gtk-list-request@gnome.org
  21 with the subject "subscribe".
  22
  23 Installation
  24 ============
  25
  26 See the file 'INSTALL'
  27
  28 How to report bugs
  29 ==================
  30
  31 Bugs should be reported to the GNOME bug tracking system.
  32 (http://bugzilla.gnome.org, product glib.) You will need
  33 to create an account for yourself.
  34
  35 In the bug report please include:
  36
  37 * Information about your system. For instance:
  38
  39    - What operating system and version
  40    - For Linux, what version of the C library
  41
  42   And anything else you think is relevant.
  43
  44 * How to reproduce the bug.
  45
  46   If you can reproduce it with one of the test programs that are built
  47   in the tests/ subdirectory, that will be most convenient.  Otherwise,
  48   please include a short test program that exhibits the behavior.
  49   As a last resort, you can also provide a pointer to a larger piece
  50   of software that can be downloaded.
  51
  52 * If the bug was a crash, the exact text that was printed out
  53   when the crash occured.
  54
  55 * Further information such as stack traces may be useful, but
  56   is not necessary.
  57
  58 Patches
  59 =======
  60
  61 Patches should also be submitted to bugzilla.gnome.org. If the
  62 patch fixes an existing bug, add the patch as an attachment
  63 to that bug report.
  64
  65 Otherwise, enter a new bug report that describes the patch,
  66 and attach the patch to that bug report.
  67
  68 Patches should be in unified diff form. (The -up option to GNU diff.)
  69
  70 Notes about GLib 2.40
  71 =====================
  72
  73 * g_test_run() no longer runs tests in exactly the order they are
  74   registered; instead, it groups them according to test suites (ie,
  75   path components) like the documentation always claimed it did. In
  76   some cases, this can result in a sub-optimal ordering of tests,
  77   relative to the old behavior. The fix is to change the test paths to
  78   properly group together the tests that should run together. (eg, if
  79   you want to run test_foo_simple(), test_bar_simple(), and
  80   test_foo_using_bar() in that order, they should have test paths like
  81   "/simple/foo", "/simple/bar", "/complex/foo-using-bar", not
  82   "/foo/simple", "/bar/simple", "/foo/using-bar" (which would result
  83   in test_foo_using_bar() running before test_bar_simple()).
  84
  85   (The behavior actually changed in GLib 2.36, but it was not
  86   documented at the time, since we didn't realize it mattered.)
  87
  88 Notes about GLib 2.36
  89 =====================
  90
  91 * It is no longer necessary to call g_type_init().  If you are
  92   loading GLib as a dynamic module, you should be careful to avoid
  93   unloading it, then subsequently loading it again.  This never
  94   really worked before, but it is now explicitly undefined behavior.
  95   Note that if g_type_init() was the only explicit use of a GObject
  96   API and you are using linker flags such as --no-add-needed, then
  97   you may have to artificially use some GObject call to keep the
  98   linker from optimizing away -lgobject. We recommend to use
  99   g_type_ensure (G_TYPE_OBJECT) for this purpose.
 100
 101 * This release contains an incompatible change to the g_get_home_dir()
 102   function.  Previously, this function would effectively ignore the HOME
 103   environment variable and always return the value from /etc/password.
 104   As of this version, the HOME variable is used if it is set and the
 105   value from /etc/passwd is only used as a fallback.
 106
 107 * The 'flowinfo' and 'scope_id' fields of GInetSocketAddress
 108   (introduced in GLib 2.32) have been fixed to be in host byte order
 109   rather than network byte order. This is an incompatible change, but
 110   the previous behavior was clearly broken, so it seems unlikely that
 111   anyone was using it.
 112
 113 Notes about GLib 2.34
 114 =====================
 115
 116 * GIO now looks for thumbnails in XDG_CACHE_HOME, following a
 117   recent alignment of the thumbnail spec with the basedir spec.
 118
 119 * The default values for GThreadPools max_unused_threads and
 120   max_idle_time settings have been changed to 2 and 15*1000,
 121   respectively.
 122
 123 Notes about GLib 2.32
 124 =====================
 125
 126 * It is no longer necessary to use g_thread_init() or to link against
 127   libgthread.  libglib is now always thread-enabled. Custom thread
 128   system implementations are no longer supported (including errorcheck
 129   mutexes).
 130
 131 * The thread and synchronisation APIs have been updated.
 132   GMutex and GCond can be statically allocated without explicit
 133   initialisation, as can new types GRWLock and GRecMutex.  The
 134   GStatic_______ variants of these types have been deprecated.  GPrivate
 135   can also be statically allocated and has a nicer API (deprecating
 136   GStaticPrivate).  Finally, g_thread_create() has been replaced with a
 137   substantially simplified g_thread_new().
 138
 139 * The g_once_init_enter()/_leave() functions have been replaced with
 140   macros that allow for a pointer to any gsize-sized object, not just a
 141   gsize*.  The assertions to ensure that a pointer to a correctly-sized
 142   object is being used will not work with generic pointers (ie: (void*)
 143   and (gpointer) casts) which would have worked with the old version.
 144
 145 * It is now mandatory to include glib.h instead of individual headers.
 146
 147 * The -uninstalled variants of the pkg-config files have been dropped.
 148
 149 * For a long time, gobject-2.0.pc mistakenly declared a public
 150   dependency on gthread-2.0.pc (when the dependency should have been
 151   private).  This means that programs got away with calling
 152   g_thread_init() without explicitly listing gthread-2.0.pc among their
 153   dependencies.
 154
 155   gthread has now been removed as a gobject dependency, which will cause
 156   such programs to break.
 157
 158   The fix for this problem is either to declare an explicit dependency
 159   on gthread-2.0.pc (if you care about compatibility with older GLib
 160   versions) or to stop calling g_thread_init().
 161
 162 * g_debug() output is no longer enabled by default.  It can be enabled
 163   on a per-domain basis with the G_MESSAGES_DEBUG environment variable
 164   like
 165     G_MESSAGES_DEBUG=domain1,domain2
 166   or
 167     G_MESSAGES_DEBUG=all
 168
 169 Notes about GLib 2.30
 170 =====================
 171
 172 * GObject includes a generic marshaller, g_cclosure_marshal_generic.
 173   To use it, simply specify NULL as the marshaller in g_signal_new().
 174   The generic marshaller is implemented with libffi, and consequently
 175   GObject depends on libffi now.
 176
 177 Notes about GLib 2.28
 178 =====================
 179
 180 * The GApplication API has changed compared to the version that was
 181   included in the 2.25 development snapshots. Existing users will need
 182   adjustments.
 183
 184 Notes about GLib 2.26
 185 =====================
 186
 187 * Nothing noteworthy.
 188
 189 Notes about GLib 2.24
 190 =====================
 191
 192 * It is now allowed to call g_thread_init(NULL) multiple times, and
 193   to call glib functions before g_thread_init(NULL) is called
 194   (although the later is mainly a change in docs as this worked before
 195   too). See the GThread reference documentation for the details.
 196
 197 * GObject now links to GThread and threads are enabled automatically
 198   when g_type_init() is called.
 199
 200 * GObject no longer allows to call g_object_set() on construct-only properties
 201   while an object is being initialized. If this behavior is needed, setting a
 202   custom constructor that just chains up will re-enable this functionality.
 203
 204 * GMappedFile on an empty file now returns NULL for the contents instead of
 205   returning an empty string. The documentation specifically states that code
 206   may not rely on nul-termination here so any breakage caused by this change
 207   is a bug in application code.
 208
 209 Notes about GLib 2.22
 210 =====================
 211
 212 * Repeated calls to g_simple_async_result_set_op_res_gpointer used
 213   to leak the data. This has been fixed to always call the provided
 214   destroy notify.
 215
 216 Notes about GLib 2.20
 217 =====================
 218
 219 * The functions for launching applications (e.g. g_app_info_launch() +
 220   friends) now passes a FUSE file:// URI if possible (requires gvfs
 221   with the FUSE daemon to be running and operational). With gvfs 2.26,
 222   FUSE file:// URIs will be mapped back to gio URIs in the GFile
 223   constructors. The intent of this change is to better integrate
 224   POSIX-only applications, see bug #528670 for the rationale.  The
 225   only user-visible change is when an application needs to examine an
 226   URI passed to it (e.g. as a positional parameter). Instead of
 227   looking at the given URI, the application will now need to look at
 228   the result of g_file_get_uri() after having constructed a GFile
 229   object with the given URI.
 230
 231 Notes about GLib 2.18
 232 =====================
 233
 234 * The recommended way of using GLib has always been to only include the
 235   toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
 236   generating an error when individual headers are directly included.
 237   To help with the transition, the enforcement is not turned on by
 238   default for GLib headers (it is turned on for GObject and GIO).
 239   To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
 240
 241 Notes about GLib 2.16
 242 =====================
 243
 244 * GLib now includes GIO, which adds optional dependencies against libattr
 245   and libselinux for extended attribute and SELinux support. Use
 246   --disable-xattr and --disable-selinux to build without these.
 247
 248 Notes about GLib 2.10
 249 =====================
 250
 251 * The functions g_snprintf() and g_vsnprintf() have been removed from
 252   the gprintf.h header, since they are already declared in glib.h. This
 253   doesn't break documented use of gprintf.h, but people have been known
 254   to include gprintf.h without including glib.h.
 255
 256 * The Unicode support has been updated to Unicode 4.1. This adds several
 257   new members to the GUnicodeBreakType enumeration.
 258
 259 * The support for Solaris threads has been retired. Solaris has provided
 260   POSIX threads for long enough now to have them available on every
 261   Solaris platform.
 262
 263 * 'make check' has been changed to validate translations by calling
 264   msgfmt with the -c option. As a result, it may fail on systems with
 265   older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
 266   'make check' will also fail on systems where the C compiler does not
 267   support ELF visibility attributes.
 268
 269 * The GMemChunk API has been deprecated in favour of a new 'slice
 270   allocator'. See the g_slice documentation for more details.
 271
 272 * A new type, GInitiallyUnowned, has been introduced, which is
 273   intended to serve as a common implementation of the 'floating reference'
 274   concept that is e.g. used by GtkObject. Note that changing the
 275   inheritance hierarchy of a type can cause problems for language
 276   bindings and other code which needs to work closely with the type
 277   system. Therefore, switching to GInitiallyUnowned should be done
 278   carefully. g_object_compat_control() has been added to GLib 2.8.5
 279   to help with the transition.
 280
 281 Notes about GLib 2.6.0
 282 ======================
 283
 284 * GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
 285   on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
 286   returning or accepting pathnames have been changed to expect
 287   filenames in this encoding, and the common POSIX functions dealing
 288   with pathnames have been wrapped. These wrappers are declared in the
 289   header <glib/gstdio.h> which must be included explicitly; it is not
 290   included through <glib.h>.
 291
 292   On current (NT-based) Windows versions, where the on-disk file names
 293   are Unicode, these wrappers use the wide-character API in the C
 294   library. Thus applications can handle file names containing any
 295   Unicode characters through GLib's own API and its POSIX wrappers,
 296   not just file names restricted to characters in the system codepage.
 297
 298   To keep binary compatibility with applications compiled against
 299   older versions of GLib, the Windows DLL still provides entry points
 300   with the old semantics using the old names, and applications
 301   compiled against GLib 2.6 will actually use new names for the
 302   functions. This is transparent to the programmer.
 303
 304   When compiling against GLib 2.6, applications intended to be
 305   portable to Windows must take the UTF-8 file name encoding into
 306   consideration, and use the gstdio wrappers to access files whose
 307   names have been constructed from strings returned from GLib.
 308
 309 * Likewise, g_get_user_name() and g_get_real_name() have been changed
 310   to return UTF-8 on Windows, while keeping the old semantics for
 311   applications compiled against older versions of GLib.
 312
 313 * The GLib uses an '_' prefix to indicate private symbols that
 314   must not be used by applications. On some platforms, symbols beginning
 315   with prefixes such as _g will be exported from the library, on others not.
 316   In no case can applications use these private symbols. In addition to that,
 317   GLib+ 2.6 makes several symbols private which were not in any installed
 318   header files and were never intended to be exported.
 319
 320 * To reduce code size and improve efficiency, GLib, when compiled
 321   with the GNU toolchain, has separate internal and external entry
 322   points for exported functions. The internal names, which begin with
 323   IA__, may be seen when debugging a GLib program.
 324
 325 * On Windows, GLib no longer opens a console window when printing
 326   warning messages if stdout or stderr are invalid, as they are in
 327   "Windows subsystem" (GUI) applications. Simply redirect stdout or
 328   stderr if you need to see them.
 329
 330 * The child watch functionality tends to reveal a bug in many
 331   thread implementations (in particular the older LinuxThreads
 332   implementation on Linux) where it's not possible to call waitpid()
 333   for a child created in a different thread. For this reason, for
 334   maximum portability, you should structure your code to fork all
 335   child processes that you want to wait for from the main thread.
 336
 337 * A problem was recently discovered with g_signal_connect_object();
 338   it doesn't actually disconnect the signal handler once the object being
 339   connected to dies, just disables it. See the API docs for the function
 340   for further details and the correct workaround that will continue to
 341   work with future versions of GLib.