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