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/gtk
  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.6.0
  28 ======================
  29
  30 * GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
  31   on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
  32   returning or accepting pathnames have been changed to expect
  33   filenames in this encoding, and the common POSIX functions dealing
  34   with pathnames have been wrapped. On Windows these wrappers use the
  35   wide-character API to do the actual file handling, so applications
  36   can handle file names containing any Unicode characters, not just
  37   those in the system codepage. (Wide character API is not available
  38   on Win9x.)
  39
  40   To keep binary compatibility with applications compiled against
  41   older versions of GLib, the Windows DLL still provides entry points
  42   with the old semantics using the old names, and applications
  43   compiled agains GLib 2.6 will actually use new names for the
  44   functions. This is transparent to the programmer.
  45
  46 * Likewise, g_get_user_name() and g_get_real_name() have been changed to return
  47   UTF-8 on Windows, while keeping the old semantics for applications compiled
  48   against older versions of GLib.
  49
  50 * The GLib uses an '_' prefix to indicate private symbols that
  51   must not be used by applications. On some platforms, symbols beginning
  52   with prefixes such as _g will be exported from the library, on others not.
  53   In no case can applications use these private symbols. In addition to that,
  54   GLib+ 2.6 makes several symbols private which were not in any installed
  55   header files and were never intended to be exported.
  56
  57 * GLib uses a technique involving macros for reducing the amount of PLT
  58   redirections which has the side effect that the names of internally used
  59   GLib functions are prefixed with IA__. The g_return_if_fail() macros
  60   strip this prefix away, but it will show up e.g. in a debugger.
  61
  62 * On Windows, GLib no longer opens a console window when printing
  63   warning messages if stdout or stderr are invalid, as they are in
  64   "Windows subsystem" (GUI) applications. Simply redirect stdout or
  65   stderr if you need to see them.
  66
  67 * The child watch functionality tends to reveal a bug in many
  68   thread implementations (in particular the older LinuxThreads implementation
  69   on Linux) where it's not possible to call waitpid() for a child
  70   created in a different thread. For this reason, for maximum portability,
  71   you should structure your code to fork all child processes that you want
  72   to wait for from the main thread.
  73
  74 * A problem was recently discovered with g_signal_connect_object();
  75   it doesn't actually disconnect the signal handler once the object being
  76   connected to dies, just disables it. See the API docs for the function
  77   for further details and the correct workaround that will continue to
  78   work with future versions of GLib.
  79
  80 How to report bugs
  81 ==================
  82
  83 Bugs should be reported to the GNOME bug tracking system.
  84 (http://bugzilla.gnome.org, product glib.) You will need
  85 to create an account for yourself.
  86
  87 In the bug report please include:
  88
  89 * Information about your system. For instance:
  90
  91    - What operating system and version
  92    - For Linux, what version of the C library
  93
  94   And anything else you think is relevant.
  95
  96 * How to reproduce the bug.
  97
  98   If you can reproduce it with the testgtk program that is built
  99   in the gtk/ subdirectory, that will be most convenient.  Otherwise,
 100   please include a short test program that exhibits the behavior.
 101   As a last resort, you can also provide a pointer to a larger piece
 102   of software that can be downloaded.
 103
 104 * If the bug was a crash, the exact text that was printed out
 105   when the crash occured.
 106
 107 * Further information such as stack traces may be useful, but
 108   is not necessary.
 109
 110 Patches
 111 =======
 112
 113 Patches should also be submitted to bugzilla.gnome.org. If the
 114 patch fixes an existing bug, add the patch as an attachment
 115 to that bug report.
 116
 117 Otherwise, enter a new bug report that describes the patch,
 118 and attach the patch to that bug report.
 119
 120 Bug reports containing patches should include the PATCH keyword
 121 in their keyword fields. If the patch adds to or changes the GLib
 122 programming interface, the API keyword should also be included.
 123
 124 Patches should be in unified diff form. (The -u option to GNU
 125 diff.)