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