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