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