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.36
  71 =====================
  72
  73 * It is no longer necessary to call g_type_init().  If you are
  74   loading GLib as a dynamic module, you should be careful to avoid
  75   unloading it, then subsequently loading it again.  This never
  76   really worked before, but it is now explicitly undefined behavior.
  77
  78 * This release contains an incompatible change to the g_get_home_dir()
  79   function.  Previously, this function would effectively ignore the HOME
  80   environment variable and always return the value from /etc/password.
  81   As of this version, the HOME variable is used if it is set and the
  82   value from /etc/passwd is only used as a fallback.
  83
  84 Notes about GLib 2.34
  85 =====================
  86
  87 * GIO now looks for thumbnails in XDG_CACHE_HOME, following a
  88   recent alignment of the thumbnail spec with the basedir spec.
  89
  90 * The default values for GThreadPools max_unused_threads and
  91   max_idle_time settings have been changed to 2 and 15*1000,
  92   respectively.
  93
  94 Notes about GLib 2.32
  95 =====================
  96
  97 * It is no longer necessary to use g_thread_init() or to link against
  98   libgthread.  libglib is now always thread-enabled. Custom thread
  99   system implementations are no longer supported (including errorcheck
 100   mutexes).
 101
 102 * The thread and synchronisation APIs have been updated.
 103   GMutex and GCond can be statically allocated without explicit
 104   initialisation, as can new types GRWLock and GRecMutex.  The
 105   GStatic_______ variants of these types have been deprecated.  GPrivate
 106   can also be statically allocated and has a nicer API (deprecating
 107   GStaticPrivate).  Finally, g_thread_create() has been replaced with a
 108   substantially simplified g_thread_new().
 109
 110 * The g_once_init_enter()/_leave() functions have been replaced with
 111   macros that allow for a pointer to any gsize-sized object, not just a
 112   gsize*.  The assertions to ensure that a pointer to a correctly-sized
 113   object is being used will not work with generic pointers (ie: (void*)
 114   and (gpointer) casts) which would have worked with the old version.
 115
 116 * It is now mandatory to include glib.h instead of individual headers.
 117
 118 * The -uninstalled variants of the pkg-config files have been dropped.
 119
 120 * For a long time, gobject-2.0.pc mistakenly declared a public
 121   dependency on gthread-2.0.pc (when the dependency should have been
 122   private).  This means that programs got away with calling
 123   g_thread_init() without explicitly listing gthread-2.0.pc among their
 124   dependencies.
 125
 126   gthread has now been removed as a gobject dependency, which will cause
 127   such programs to break.
 128
 129   The fix for this problem is either to declare an explicit dependency
 130   on gthread-2.0.pc (if you care about compatibility with older GLib
 131   versions) or to stop calling g_thread_init().
 132
 133 * g_debug() output is no longer enabled by default.  It can be enabled
 134   on a per-domain basis with the G_MESSAGES_DEBUG environment variable
 135   like
 136     G_MESSAGES_DEBUG=domain1,domain2
 137   or
 138     G_MESSAGES_DEBUG=all
 139
 140 Notes about GLib 2.30
 141 =====================
 142
 143 * GObject includes a generic marshaller, g_cclosure_marshal_generic.
 144   To use it, simply specify NULL as the marshaller in g_signal_new().
 145   The generic marshaller is implemented with libffi, and consequently
 146   GObject depends on libffi now.
 147
 148 Notes about GLib 2.28
 149 =====================
 150
 151 * The GApplication API has changed compared to the version that was
 152   included in the 2.25 development snapshots. Existing users will need
 153   adjustments.
 154
 155 Notes about GLib 2.26
 156 =====================
 157
 158 * Nothing noteworthy.
 159
 160 Notes about GLib 2.24
 161 =====================
 162
 163 * It is now allowed to call g_thread_init(NULL) multiple times, and
 164   to call glib functions before g_thread_init(NULL) is called
 165   (although the later is mainly a change in docs as this worked before
 166   too). See the GThread reference documentation for the details.
 167
 168 * GObject now links to GThread and threads are enabled automatically
 169   when g_type_init() is called.
 170
 171 * GObject no longer allows to call g_object_set() on construct-only properties
 172   while an object is being initialized. If this behavior is needed, setting a
 173   custom constructor that just chains up will re-enable this functionality.
 174
 175 * GMappedFile on an empty file now returns NULL for the contents instead of
 176   returning an empty string. The documentation specifically states that code
 177   may not rely on nul-termination here so any breakage caused by this change
 178   is a bug in application code.
 179
 180 Notes about GLib 2.22
 181 =====================
 182
 183 * Repeated calls to g_simple_async_result_set_op_res_gpointer used
 184   to leak the data. This has been fixed to always call the provided
 185   destroy notify.
 186
 187 Notes about GLib 2.20
 188 =====================
 189
 190 * The functions for launching applications (e.g. g_app_info_launch() +
 191   friends) now passes a FUSE file:// URI if possible (requires gvfs
 192   with the FUSE daemon to be running and operational). With gvfs 2.26,
 193   FUSE file:// URIs will be mapped back to gio URIs in the GFile
 194   constructors. The intent of this change is to better integrate
 195   POSIX-only applications, see bug #528670 for the rationale.  The
 196   only user-visible change is when an application needs to examine an
 197   URI passed to it (e.g. as a positional parameter). Instead of
 198   looking at the given URI, the application will now need to look at
 199   the result of g_file_get_uri() after having constructed a GFile
 200   object with the given URI.
 201
 202 Notes about GLib 2.18
 203 =====================
 204
 205 * The recommended way of using GLib has always been to only include the
 206   toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
 207   generating an error when individual headers are directly included.
 208   To help with the transition, the enforcement is not turned on by
 209   default for GLib headers (it is turned on for GObject and GIO).
 210   To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
 211
 212 Notes about GLib 2.16
 213 =====================
 214
 215 * GLib now includes GIO, which adds optional dependencies against libattr
 216   and libselinux for extended attribute and SELinux support. Use
 217   --disable-xattr and --disable-selinux to build without these.
 218
 219 Notes about GLib 2.10
 220 =====================
 221
 222 * The functions g_snprintf() and g_vsnprintf() have been removed from
 223   the gprintf.h header, since they are already declared in glib.h. This
 224   doesn't break documented use of gprintf.h, but people have been known
 225   to include gprintf.h without including glib.h.
 226
 227 * The Unicode support has been updated to Unicode 4.1. This adds several
 228   new members to the GUnicodeBreakType enumeration.
 229
 230 * The support for Solaris threads has been retired. Solaris has provided
 231   POSIX threads for long enough now to have them available on every
 232   Solaris platform.
 233
 234 * 'make check' has been changed to validate translations by calling
 235   msgfmt with the -c option. As a result, it may fail on systems with
 236   older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
 237   'make check' will also fail on systems where the C compiler does not
 238   support ELF visibility attributes.
 239
 240 * The GMemChunk API has been deprecated in favour of a new 'slice
 241   allocator'. See the g_slice documentation for more details.
 242
 243 * A new type, GInitiallyUnowned, has been introduced, which is
 244   intended to serve as a common implementation of the 'floating reference'
 245   concept that is e.g. used by GtkObject. Note that changing the
 246   inheritance hierarchy of a type can cause problems for language
 247   bindings and other code which needs to work closely with the type
 248   system. Therefore, switching to GInitiallyUnowned should be done
 249   carefully. g_object_compat_control() has been added to GLib 2.8.5
 250   to help with the transition.
 251
 252 Notes about GLib 2.6.0
 253 ======================
 254
 255 * GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
 256   on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
 257   returning or accepting pathnames have been changed to expect
 258   filenames in this encoding, and the common POSIX functions dealing
 259   with pathnames have been wrapped. These wrappers are declared in the
 260   header <glib/gstdio.h> which must be included explicitly; it is not
 261   included through <glib.h>.
 262
 263   On current (NT-based) Windows versions, where the on-disk file names
 264   are Unicode, these wrappers use the wide-character API in the C
 265   library. Thus applications can handle file names containing any
 266   Unicode characters through GLib's own API and its POSIX wrappers,
 267   not just file names restricted to characters in the system codepage.
 268
 269   To keep binary compatibility with applications compiled against
 270   older versions of GLib, the Windows DLL still provides entry points
 271   with the old semantics using the old names, and applications
 272   compiled against GLib 2.6 will actually use new names for the
 273   functions. This is transparent to the programmer.
 274
 275   When compiling against GLib 2.6, applications intended to be
 276   portable to Windows must take the UTF-8 file name encoding into
 277   consideration, and use the gstdio wrappers to access files whose
 278   names have been constructed from strings returned from GLib.
 279
 280 * Likewise, g_get_user_name() and g_get_real_name() have been changed
 281   to return UTF-8 on Windows, while keeping the old semantics for
 282   applications compiled against older versions of GLib.
 283
 284 * The GLib uses an '_' prefix to indicate private symbols that
 285   must not be used by applications. On some platforms, symbols beginning
 286   with prefixes such as _g will be exported from the library, on others not.
 287   In no case can applications use these private symbols. In addition to that,
 288   GLib+ 2.6 makes several symbols private which were not in any installed
 289   header files and were never intended to be exported.
 290
 291 * To reduce code size and improve efficiency, GLib, when compiled
 292   with the GNU toolchain, has separate internal and external entry
 293   points for exported functions. The internal names, which begin with
 294   IA__, may be seen when debugging a GLib program.
 295
 296 * On Windows, GLib no longer opens a console window when printing
 297   warning messages if stdout or stderr are invalid, as they are in
 298   "Windows subsystem" (GUI) applications. Simply redirect stdout or
 299   stderr if you need to see them.
 300
 301 * The child watch functionality tends to reveal a bug in many
 302   thread implementations (in particular the older LinuxThreads
 303   implementation on Linux) where it's not possible to call waitpid()
 304   for a child created in a different thread. For this reason, for
 305   maximum portability, you should structure your code to fork all
 306   child processes that you want to wait for from the main thread.
 307
 308 * A problem was recently discovered with g_signal_connect_object();
 309   it doesn't actually disconnect the signal handler once the object being
 310   connected to dies, just disables it. See the API docs for the function
 311   for further details and the correct workaround that will continue to
 312   work with future versions of GLib.