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