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