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