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