fae504f927946b03b88ea96fb62a685bbd323e06
[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.4.0
28 ======================
29
30 * GObject now enforces CONSTRUCT_ONLY properties; due to an oversight
31   in previous versions, it was possible to set CONSTRUCT_ONLY properties
32   after construct time.
33
34 * The child watch functionality tends to reveal a bug in many
35   thread implementations (in particular the older LinuxThreads implementation
36   on Linux) where it's not possible to call waitpid() for a child
37   created in a different thread. For this reason, for maximum portability,
38   you should structure your code to fork all child processes that you want
39   to wait for from the main thread.
40
41 * A problem was recently discovered with g_signal_connect_object(); 
42   it doesn't actually disconnect the signal handler once the object being 
43   connected to dies, just disables it. See the API docs for the function 
44   for further details and the correct workaround that will continue to 
45   work with future versions of GLib.
46
47 How to report bugs
48 ==================
49
50 Bugs should be reported to the GNOME bug tracking system. 
51 (http://bugzilla.gnome.org, product glib.) You will need
52 to create an account for yourself.
53
54 In the bug report please include:
55
56 * Information about your system. For instance:
57
58    - What operating system and version
59    - For Linux, what version of the C library
60
61   And anything else you think is relevant.
62
63 * How to reproduce the bug. 
64
65   If you can reproduce it with the testgtk program that is built 
66   in the gtk/ subdirectory, that will be most convenient.  Otherwise, 
67   please include a short test program that exhibits the behavior. 
68   As a last resort, you can also provide a pointer to a larger piece 
69   of software that can be downloaded.
70
71 * If the bug was a crash, the exact text that was printed out
72   when the crash occured.
73
74 * Further information such as stack traces may be useful, but
75   is not necessary.
76
77 Patches
78 =======
79
80 Patches should also be submitted to bugzilla.gnome.org. If the
81 patch fixes an existing bug, add the patch as an attachment
82 to that bug report.
83
84 Otherwise, enter a new bug report that describes the patch,
85 and attach the patch to that bug report.
86
87 Bug reports containing patches should include the PATCH keyword
88 in their keyword fields. If the patch adds to or changes the GLib 
89 programming interface, the API keyword should also be included.
90
91 Patches should be in unified diff form. (The -u option to GNU
92 diff.)