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