fe5f9cea27365efed6ba6c2bbf0bef974833cc4c
[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.0.0
28 ======================
29
30 * On systems without the libintl from GNU gettext() or a recent version
31   of the GNU C library, the encoding of translated error messages will be 
32   incorrect (they should be in UTF-8). A workaround for this is to install 
33   GNU gettext and use that libintl. This is expected to be fixed in GLib-2.0.1.
34   Application programmers should not call g_locale_to_utf8() on these
35   strings.
36
37 * Similarly, the GLib error logging functions such as g_print(), g_warning(),
38   g_error(), currently do not convert the strings they are passed from
39   UTF-8 to the encoding of the locale, or check that the strings they
40   are passed are valid UTF-8. They should, despite this, be assumed to take
41   UTF-8 arguments.
42
43
44 How to report bugs
45 ==================
46
47 Bugs should be reported to the GNOME bug tracking system. 
48 (http://bugzilla.gnome.org, product glib.) You will need
49 to create an account for yourself.
50
51 In the bug report please include:
52
53 * Information about your system. For instance:
54
55    - What operating system and version
56    - For Linux, what version of the C library
57
58   And anything else you think is relevant.
59
60 * How to reproduce the bug. 
61
62   If you can reproduce it with the testgtk program that is built 
63   in the gtk/ subdirectory, that will be most convenient.  Otherwise, 
64   please include a short test program that exhibits the behavior. 
65   As a last resort, you can also provide a pointer to a larger piece 
66   of software that can be downloaded.
67
68 * If the bug was a crash, the exact text that was printed out
69   when the crash occured.
70
71 * Further information such as stack traces may be useful, but
72   is not necessary.
73
74 Patches
75 =======
76
77 Patches should also be submitted to bugzilla.gnome.org. If the
78 patch fixes an existing bug, add the patch as an attachment
79 to that bug report.
80
81 Otherwise, enter a new bug report that describes the patch,
82 and attach the patch to that bug report.
83
84 Bug reports containing patches should include the PATCH keyword
85 in their keyword fields. If the patch adds to or changes the GLib 
86 programming interface, the API keyword should also be included.
87
88 Patches should be in unified diff form. (The -u option to GNU
89 diff.)