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