README.in 9.14 KB
Newer Older
1 2 3
General Information
===================

Owen Taylor's avatar
Owen Taylor committed
4 5 6 7 8
This is GLib version @GLIB_VERSION@. GLib is the low-level core
library that forms the basis for projects such as GTK+ and GNOME. It
provides data structure handling for C, portability wrappers, and
interfaces for such runtime functionality as an event loop, threads,
dynamic loading, and an object system.
9 10

The official ftp site is:
Matthias Clasen's avatar
Matthias Clasen committed
11
  ftp://ftp.gtk.org/pub/glib
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

The official web site is:
  http://www.gtk.org/

Information about mailing lists can be found at
  http://www.gtk.org/mailinglists.html

To subscribe: mail -s subscribe gtk-list-request@gnome.org < /dev/null
(Send mail to gtk-list-request@gnome.org with the subject "subscribe")

Installation
============

See the file 'INSTALL'

Matthias Clasen's avatar
Matthias Clasen committed
27 28 29
Notes about GLib 2.24
=====================

30 31 32 33 34 35 36 37
* It is now allowed to call g_thread_init(NULL) multiple times, and
  to call glib functions before g_thread_init(NULL) is called
  (although the later is mainly a change in docs as this worked before
  too). See the GThread reference documentation for the details.

* GObject now links to GThread and threads are enabled automatically
  when g_type_init() is called.

Matthias Clasen's avatar
Matthias Clasen committed
38 39 40 41
* GObject no longer allows to call g_object_set() on construct-only properties
  while an object is being initialized. If this behavior is needed, setting a
  custom constructor that just chains up will re-enable this functionality.

42 43 44 45 46
* GMappedFile on an empty file now returns NULL for the contents instead of
  returning an empty string. The documentation specifically states that code
  may not rely on nul-termination here so any breakage caused by this change
  is a bug in application code.

47 48 49 50 51 52 53
Notes about GLib 2.22
=====================

* Repeated calls to g_simple_async_result_set_op_res_gpointer used
  to leak the data. This has been fixed to always call the provided
  destroy notify.

54 55 56
Notes about GLib 2.20
=====================

Matthias Clasen's avatar
Matthias Clasen committed
57
* The functions for launching applications (e.g. g_app_info_launch() +
58 59 60 61 62 63 64 65 66 67 68
  friends) now passes a FUSE file:// URI if possible (requires gvfs
  with the FUSE daemon to be running and operational). With gvfs 2.26,
  FUSE file:// URIs will be mapped back to gio URIs in the GFile
  constructors. The intent of this change is to better integrate
  POSIX-only applications, see bug #528670 for the rationale.  The
  only user-visible change is when an application needs to examine an
  URI passed to it (e.g. as a positional parameter). Instead of
  looking at the given URI, the application will now need to look at
  the result of g_file_get_uri() after having constructed a GFile
  object with the given URI.

Matthias Clasen's avatar
Matthias Clasen committed
69 70 71 72
Notes about GLib 2.18
=====================

* The recommended way of using GLib has always been to only include the
Matthias Clasen's avatar
Matthias Clasen committed
73 74 75
  toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
  generating an error when individual headers are directly included.
  To help with the transition, the enforcement is not turned on by
Matthias Clasen's avatar
Matthias Clasen committed
76 77
  default for GLib headers (it is turned on for GObject and GIO).
  To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
Matthias Clasen's avatar
Matthias Clasen committed
78

Matthias Clasen's avatar
Matthias Clasen committed
79 80 81 82
Notes about GLib 2.16
=====================

* GLib now includes GIO, which adds optional dependencies against libattr
Matthias Clasen's avatar
Matthias Clasen committed
83
  and libselinux for extended attribute and SELinux support. Use
Matthias Clasen's avatar
Matthias Clasen committed
84 85
  --disable-xattr and --disable-selinux to build without these.

Matthias Clasen's avatar
Matthias Clasen committed
86 87 88 89 90 91 92 93 94 95 96
Notes about GLib 2.10
=====================

* The functions g_snprintf() and g_vsnprintf() have been removed from
  the gprintf.h header, since they are already declared in glib.h. This
  doesn't break documented use of gprintf.h, but people have been known
  to include gprintf.h without including glib.h.

* The Unicode support has been updated to Unicode 4.1. This adds several
  new members to the GUnicodeBreakType enumeration.

Matthias Clasen's avatar
Matthias Clasen committed
97 98 99
* The support for Solaris threads has been retired. Solaris has provided
  POSIX threads for long enough now to have them available on every
  Solaris platform.
100

Matthias Clasen's avatar
Matthias Clasen committed
101 102 103
* 'make check' has been changed to validate translations by calling
  msgfmt with the -c option. As a result, it may fail on systems with
  older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
Matthias Clasen's avatar
Matthias Clasen committed
104 105
  'make check' will also fail on systems where the C compiler does not
  support ELF visibility attributes.
106

Matthias Clasen's avatar
Matthias Clasen committed
107 108
* The GMemChunk API has been deprecated in favour of a new 'slice
  allocator'. See the g_slice documentation for more details.
Matthias Clasen's avatar
Matthias Clasen committed
109 110 111 112 113 114 115 116 117 118

* A new type, GInitiallyUnowned, has been introduced, which is
  intended to serve as a common implementation of the 'floating reference'
  concept that is e.g. used by GtkObject. Note that changing the
  inheritance hierarchy of a type can cause problems for language
  bindings and other code which needs to work closely with the type
  system. Therefore, switching to GInitiallyUnowned should be done
  carefully. g_object_compat_control() has been added to GLib 2.8.5
  to help with the transition.

Matthias Clasen's avatar
Matthias Clasen committed
119
Notes about GLib 2.6.0
120 121
======================

Tor Lillqvist's avatar
Tor Lillqvist committed
122 123 124 125
* GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
  on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
  returning or accepting pathnames have been changed to expect
  filenames in this encoding, and the common POSIX functions dealing
Tor Lillqvist's avatar
Tor Lillqvist committed
126
  with pathnames have been wrapped. These wrappers are declared in the
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
127
  header <glib/gstdio.h> which must be included explicitly; it is not
Tor Lillqvist's avatar
Tor Lillqvist committed
128 129 130 131 132 133 134
  included through <glib.h>.

  On current (NT-based) Windows versions, where the on-disk file names
  are Unicode, these wrappers use the wide-character API in the C
  library. Thus applications can handle file names containing any
  Unicode characters through GLib's own API and its POSIX wrappers,
  not just file names restricted to characters in the system codepage.
Tor Lillqvist's avatar
Tor Lillqvist committed
135 136 137 138

  To keep binary compatibility with applications compiled against
  older versions of GLib, the Windows DLL still provides entry points
  with the old semantics using the old names, and applications
Tor Lillqvist's avatar
Tor Lillqvist committed
139
  compiled against GLib 2.6 will actually use new names for the
Tor Lillqvist's avatar
Tor Lillqvist committed
140
  functions. This is transparent to the programmer.
Matthias Clasen's avatar
Matthias Clasen committed
141

Tor Lillqvist's avatar
Tor Lillqvist committed
142 143 144 145 146
  When compiling against GLib 2.6, applications intended to be
  portable to Windows must take the UTF-8 file name encoding into
  consideration, and use the gstdio wrappers to access files whose
  names have been constructed from strings returned from GLib.

Matthias Clasen's avatar
Matthias Clasen committed
147 148
* Likewise, g_get_user_name() and g_get_real_name() have been changed
  to return UTF-8 on Windows, while keeping the old semantics for
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
149
  applications compiled against older versions of GLib.
Matthias Clasen's avatar
Matthias Clasen committed
150 151

* The GLib uses an '_' prefix to indicate private symbols that
Matthias Clasen's avatar
Matthias Clasen committed
152 153 154 155
  must not be used by applications. On some platforms, symbols beginning
  with prefixes such as _g will be exported from the library, on others not.
  In no case can applications use these private symbols. In addition to that,
  GLib+ 2.6 makes several symbols private which were not in any installed
Matthias Clasen's avatar
Matthias Clasen committed
156 157
  header files and were never intended to be exported.

Matthias Clasen's avatar
Matthias Clasen committed
158 159 160
* To reduce code size and improve efficiency, GLib, when compiled
  with the GNU toolchain, has separate internal and external entry
  points for exported functions. The internal names, which begin with
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
161
  IA__, may be seen when debugging a GLib program.
Matthias Clasen's avatar
Matthias Clasen committed
162

Tor Lillqvist's avatar
Tor Lillqvist committed
163 164 165 166
* On Windows, GLib no longer opens a console window when printing
  warning messages if stdout or stderr are invalid, as they are in
  "Windows subsystem" (GUI) applications. Simply redirect stdout or
  stderr if you need to see them.
Owen Taylor's avatar
Owen Taylor committed
167 168

* The child watch functionality tends to reveal a bug in many
Matthias Clasen's avatar
Matthias Clasen committed
169 170 171 172
  thread implementations (in particular the older LinuxThreads
  implementation on Linux) where it's not possible to call waitpid()
  for a child created in a different thread. For this reason, for
  maximum portability, you should structure your code to fork all
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
173
  child processes that you want to wait for from the main thread.
Owen Taylor's avatar
Owen Taylor committed
174

Matthias Clasen's avatar
Matthias Clasen committed
175 176 177 178
* A problem was recently discovered with g_signal_connect_object();
  it doesn't actually disconnect the signal handler once the object being
  connected to dies, just disables it. See the API docs for the function
  for further details and the correct workaround that will continue to
Owen Taylor's avatar
Owen Taylor committed
179
  work with future versions of GLib.
180

181 182 183
How to report bugs
==================

Matthias Clasen's avatar
Matthias Clasen committed
184
Bugs should be reported to the GNOME bug tracking system.
185 186 187 188 189 190 191 192 193 194 195 196
(http://bugzilla.gnome.org, product glib.) You will need
to create an account for yourself.

In the bug report please include:

* Information about your system. For instance:

   - What operating system and version
   - For Linux, what version of the C library

  And anything else you think is relevant.

Matthias Clasen's avatar
Matthias Clasen committed
197
* How to reproduce the bug.
198

Matthias Clasen's avatar
Matthias Clasen committed
199 200 201 202
  If you can reproduce it with one of the test programs that are built
  in the tests/ subdirectory, that will be most convenient.  Otherwise,
  please include a short test program that exhibits the behavior.
  As a last resort, you can also provide a pointer to a larger piece
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
  of software that can be downloaded.

* If the bug was a crash, the exact text that was printed out
  when the crash occured.

* Further information such as stack traces may be useful, but
  is not necessary.

Patches
=======

Patches should also be submitted to bugzilla.gnome.org. If the
patch fixes an existing bug, add the patch as an attachment
to that bug report.

Otherwise, enter a new bug report that describes the patch,
and attach the patch to that bug report.

Matthias Clasen's avatar
Matthias Clasen committed
221
Patches should be in unified diff form. (The -up option to GNUdiff.)