Updated Czech translation
[platform/upstream/glib.git] / 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 download locations are:
11   ftp://ftp.gtk.org/pub/glib
12   http://download.gnome.org/sources/glib
13
14 The official web site is:
15   http://www.gtk.org/
16
17 Information about mailing lists can be found at
18   http://www.gtk.org/mailing-lists.php
19
20 To subscribe, send mail to gtk-list-request@gnome.org
21 with the subject "subscribe".
22
23 Installation
24 ============
25
26 See the file 'INSTALL'
27
28 How to report bugs
29 ==================
30
31 Bugs should be reported to the GNOME bug tracking system.
32 (http://bugzilla.gnome.org, product glib.) You will need
33 to create an account for yourself.
34
35 In the bug report please include:
36
37 * Information about your system. For instance:
38
39    - What operating system and version
40    - For Linux, what version of the C library
41
42   And anything else you think is relevant.
43
44 * How to reproduce the bug.
45
46   If you can reproduce it with one of the test programs that are built
47   in the tests/ subdirectory, that will be most convenient.  Otherwise,
48   please include a short test program that exhibits the behavior.
49   As a last resort, you can also provide a pointer to a larger piece
50   of software that can be downloaded.
51
52 * If the bug was a crash, the exact text that was printed out
53   when the crash occured.
54
55 * Further information such as stack traces may be useful, but
56   is not necessary.
57
58 Patches
59 =======
60
61 Patches should also be submitted to bugzilla.gnome.org. If the
62 patch fixes an existing bug, add the patch as an attachment
63 to that bug report.
64
65 Otherwise, enter a new bug report that describes the patch,
66 and attach the patch to that bug report.
67
68 Patches should be in unified diff form. (The -up option to GNU diff.)
69
70 Notes about GLib 2.36
71 =====================
72
73 * It is no longer necessary to call g_type_init().  If you are
74   loading GLib as a dynamic module, you should be careful to avoid
75   unloading it, then subsequently loading it again.  This never
76   really worked before, but it is now explicitly undefined behavior.
77   Note that if g_type_init() was the only explicit use of a GObject
78   API and you are using linker flags such as --no-add-needed, then
79   you may have to artificially use some GObject call to keep the
80   linker from optimizing away -lgobject. We recommend to use
81   g_type_ensure (G_TYPE_OBJECT) for this purpose.
82
83 * This release contains an incompatible change to the g_get_home_dir()
84   function.  Previously, this function would effectively ignore the HOME
85   environment variable and always return the value from /etc/password.
86   As of this version, the HOME variable is used if it is set and the
87   value from /etc/passwd is only used as a fallback.
88
89 * The 'flowinfo' and 'scope_id' fields of GInetSocketAddress
90   (introduced in GLib 2.32) have been fixed to be in host byte order
91   rather than network byte order. This is an incompatible change, but
92   the previous behavior was clearly broken, so it seems unlikely that
93   anyone was using it.
94
95 Notes about GLib 2.34
96 =====================
97
98 * GIO now looks for thumbnails in XDG_CACHE_HOME, following a
99   recent alignment of the thumbnail spec with the basedir spec.
100
101 * The default values for GThreadPools max_unused_threads and
102   max_idle_time settings have been changed to 2 and 15*1000,
103   respectively.
104
105 Notes about GLib 2.32
106 =====================
107
108 * It is no longer necessary to use g_thread_init() or to link against
109   libgthread.  libglib is now always thread-enabled. Custom thread
110   system implementations are no longer supported (including errorcheck
111   mutexes).
112
113 * The thread and synchronisation APIs have been updated.
114   GMutex and GCond can be statically allocated without explicit
115   initialisation, as can new types GRWLock and GRecMutex.  The
116   GStatic_______ variants of these types have been deprecated.  GPrivate
117   can also be statically allocated and has a nicer API (deprecating
118   GStaticPrivate).  Finally, g_thread_create() has been replaced with a
119   substantially simplified g_thread_new().
120
121 * The g_once_init_enter()/_leave() functions have been replaced with
122   macros that allow for a pointer to any gsize-sized object, not just a
123   gsize*.  The assertions to ensure that a pointer to a correctly-sized
124   object is being used will not work with generic pointers (ie: (void*)
125   and (gpointer) casts) which would have worked with the old version.
126
127 * It is now mandatory to include glib.h instead of individual headers.
128
129 * The -uninstalled variants of the pkg-config files have been dropped.
130
131 * For a long time, gobject-2.0.pc mistakenly declared a public
132   dependency on gthread-2.0.pc (when the dependency should have been
133   private).  This means that programs got away with calling
134   g_thread_init() without explicitly listing gthread-2.0.pc among their
135   dependencies.
136
137   gthread has now been removed as a gobject dependency, which will cause
138   such programs to break.
139
140   The fix for this problem is either to declare an explicit dependency
141   on gthread-2.0.pc (if you care about compatibility with older GLib
142   versions) or to stop calling g_thread_init().
143
144 * g_debug() output is no longer enabled by default.  It can be enabled
145   on a per-domain basis with the G_MESSAGES_DEBUG environment variable
146   like
147     G_MESSAGES_DEBUG=domain1,domain2
148   or
149     G_MESSAGES_DEBUG=all
150
151 Notes about GLib 2.30
152 =====================
153
154 * GObject includes a generic marshaller, g_cclosure_marshal_generic.
155   To use it, simply specify NULL as the marshaller in g_signal_new().
156   The generic marshaller is implemented with libffi, and consequently
157   GObject depends on libffi now.
158
159 Notes about GLib 2.28
160 =====================
161
162 * The GApplication API has changed compared to the version that was
163   included in the 2.25 development snapshots. Existing users will need
164   adjustments.
165
166 Notes about GLib 2.26
167 =====================
168
169 * Nothing noteworthy.
170
171 Notes about GLib 2.24
172 =====================
173
174 * It is now allowed to call g_thread_init(NULL) multiple times, and
175   to call glib functions before g_thread_init(NULL) is called
176   (although the later is mainly a change in docs as this worked before
177   too). See the GThread reference documentation for the details.
178
179 * GObject now links to GThread and threads are enabled automatically
180   when g_type_init() is called.
181
182 * GObject no longer allows to call g_object_set() on construct-only properties
183   while an object is being initialized. If this behavior is needed, setting a
184   custom constructor that just chains up will re-enable this functionality.
185
186 * GMappedFile on an empty file now returns NULL for the contents instead of
187   returning an empty string. The documentation specifically states that code
188   may not rely on nul-termination here so any breakage caused by this change
189   is a bug in application code.
190
191 Notes about GLib 2.22
192 =====================
193
194 * Repeated calls to g_simple_async_result_set_op_res_gpointer used
195   to leak the data. This has been fixed to always call the provided
196   destroy notify.
197
198 Notes about GLib 2.20
199 =====================
200
201 * The functions for launching applications (e.g. g_app_info_launch() +
202   friends) now passes a FUSE file:// URI if possible (requires gvfs
203   with the FUSE daemon to be running and operational). With gvfs 2.26,
204   FUSE file:// URIs will be mapped back to gio URIs in the GFile
205   constructors. The intent of this change is to better integrate
206   POSIX-only applications, see bug #528670 for the rationale.  The
207   only user-visible change is when an application needs to examine an
208   URI passed to it (e.g. as a positional parameter). Instead of
209   looking at the given URI, the application will now need to look at
210   the result of g_file_get_uri() after having constructed a GFile
211   object with the given URI.
212
213 Notes about GLib 2.18
214 =====================
215
216 * The recommended way of using GLib has always been to only include the
217   toplevel headers glib.h, glib-object.h and gio.h. GLib enforces this by
218   generating an error when individual headers are directly included.
219   To help with the transition, the enforcement is not turned on by
220   default for GLib headers (it is turned on for GObject and GIO).
221   To turn it on, define the preprocessor symbol G_DISABLE_SINGLE_INCLUDES.
222
223 Notes about GLib 2.16
224 =====================
225
226 * GLib now includes GIO, which adds optional dependencies against libattr
227   and libselinux for extended attribute and SELinux support. Use
228   --disable-xattr and --disable-selinux to build without these.
229
230 Notes about GLib 2.10
231 =====================
232
233 * The functions g_snprintf() and g_vsnprintf() have been removed from
234   the gprintf.h header, since they are already declared in glib.h. This
235   doesn't break documented use of gprintf.h, but people have been known
236   to include gprintf.h without including glib.h.
237
238 * The Unicode support has been updated to Unicode 4.1. This adds several
239   new members to the GUnicodeBreakType enumeration.
240
241 * The support for Solaris threads has been retired. Solaris has provided
242   POSIX threads for long enough now to have them available on every
243   Solaris platform.
244
245 * 'make check' has been changed to validate translations by calling
246   msgfmt with the -c option. As a result, it may fail on systems with
247   older gettext implementations (GNU gettext < 0.14.1, or Solaris gettext).
248   'make check' will also fail on systems where the C compiler does not
249   support ELF visibility attributes.
250
251 * The GMemChunk API has been deprecated in favour of a new 'slice
252   allocator'. See the g_slice documentation for more details.
253
254 * A new type, GInitiallyUnowned, has been introduced, which is
255   intended to serve as a common implementation of the 'floating reference'
256   concept that is e.g. used by GtkObject. Note that changing the
257   inheritance hierarchy of a type can cause problems for language
258   bindings and other code which needs to work closely with the type
259   system. Therefore, switching to GInitiallyUnowned should be done
260   carefully. g_object_compat_control() has been added to GLib 2.8.5
261   to help with the transition.
262
263 Notes about GLib 2.6.0
264 ======================
265
266 * GLib 2.6 introduces the concept of 'GLib filename encoding', which is the
267   on-disk encoding on Unix, but UTF-8 on Windows. All GLib functions
268   returning or accepting pathnames have been changed to expect
269   filenames in this encoding, and the common POSIX functions dealing
270   with pathnames have been wrapped. These wrappers are declared in the
271   header <glib/gstdio.h> which must be included explicitly; it is not
272   included through <glib.h>.
273
274   On current (NT-based) Windows versions, where the on-disk file names
275   are Unicode, these wrappers use the wide-character API in the C
276   library. Thus applications can handle file names containing any
277   Unicode characters through GLib's own API and its POSIX wrappers,
278   not just file names restricted to characters in the system codepage.
279
280   To keep binary compatibility with applications compiled against
281   older versions of GLib, the Windows DLL still provides entry points
282   with the old semantics using the old names, and applications
283   compiled against GLib 2.6 will actually use new names for the
284   functions. This is transparent to the programmer.
285
286   When compiling against GLib 2.6, applications intended to be
287   portable to Windows must take the UTF-8 file name encoding into
288   consideration, and use the gstdio wrappers to access files whose
289   names have been constructed from strings returned from GLib.
290
291 * Likewise, g_get_user_name() and g_get_real_name() have been changed
292   to return UTF-8 on Windows, while keeping the old semantics for
293   applications compiled against older versions of GLib.
294
295 * The GLib uses an '_' prefix to indicate private symbols that
296   must not be used by applications. On some platforms, symbols beginning
297   with prefixes such as _g will be exported from the library, on others not.
298   In no case can applications use these private symbols. In addition to that,
299   GLib+ 2.6 makes several symbols private which were not in any installed
300   header files and were never intended to be exported.
301
302 * To reduce code size and improve efficiency, GLib, when compiled
303   with the GNU toolchain, has separate internal and external entry
304   points for exported functions. The internal names, which begin with
305   IA__, may be seen when debugging a GLib program.
306
307 * On Windows, GLib no longer opens a console window when printing
308   warning messages if stdout or stderr are invalid, as they are in
309   "Windows subsystem" (GUI) applications. Simply redirect stdout or
310   stderr if you need to see them.
311
312 * The child watch functionality tends to reveal a bug in many
313   thread implementations (in particular the older LinuxThreads
314   implementation on Linux) where it's not possible to call waitpid()
315   for a child created in a different thread. For this reason, for
316   maximum portability, you should structure your code to fork all
317   child processes that you want to wait for from the main thread.
318
319 * A problem was recently discovered with g_signal_connect_object();
320   it doesn't actually disconnect the signal handler once the object being
321   connected to dies, just disables it. See the API docs for the function
322   for further details and the correct workaround that will continue to
323   work with future versions of GLib.