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