]> Pileus Git - ~andy/gtk/blob - README.in
Start collecting release notes for 2.10.
[~andy/gtk] / README.in
1 General Information
2 ===================
3
4 This is GTK+ version @GTK_VERSION@. GTK+ is a multi-platform toolkit for
5 creating graphical user interfaces. Offering a complete set of widgets,
6 GTK+ is suitable for projects ranging from small one-off projects to
7 complete application suites.
8
9 GTK+ is free software and part of the GNU Project. However, the
10 licensing terms for GTK+, the GNU LGPL, allow it to be used by all
11 developers, including those developing proprietary software, without any
12 license fees or royalties.
13
14 The official ftp site is:
15   ftp://ftp.gtk.org/pub/gtk
16
17 The official web site is:
18   http://www.gtk.org/
19
20 Information about mailing lists can be found at
21   http://www.gtk.org/mailinglists.html
22
23 Installation
24 ============
25
26 See the file 'INSTALL'
27
28 Release notes for 2.10
29 ======================
30
31 * The hexadecimal Unicode input feature has been reworked. It no longer
32   blocks the use of the sixteen Ctrl-Shift-<hex digit> key sequences. Now
33   it only uses Ctrl-Shift-u.
34
35 * A memory leak in GtkStyle handling has been fixed. This may expose bugs
36   in third-party widgets which forget to call gtk_style_attach() in their
37   realize functions.
38
39 Release notes
40 =============
41
42 * GTK+ 2.6 supports clipboard persistency. To make use of this feature,
43   a clipboard manager following the specification at
44   http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
45   must be running. A sample implementation of such a clipboard manager
46   is available at 
47   http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
48   Applications can use the function gdk_display_supports_clipboard_persistence() 
49   to find out if clipboard persistence is available.
50
51 * Notification on clipboard ownership changes via GdkOwnerChange events 
52   requires the XFIXES X extension. Applications can use the function
53   gdk_display_supports_selection_notification() to find out if ownerchip
54   change notification is available.
55
56 * The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
57   specification. Setting the XDG_DATA_DIRS environtment variable may be 
58   necessary if your icons aren't installed in the default location 
59   /usr/share/icons.
60
61 * The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
62   to avoid a lot of disk searching overhead. GTK+ includes a utility named
63   gtk-update-icon-cache to generate these cache files. For further details,
64   see the gtk-update-icon-cache man page or the GTK+ documentation.
65
66 * To reduce code size and improve efficiency, GTK+, when compiled 
67   with the GNU toolchain, has separate internal and external entry 
68   points for exported functions. The internal names, which begin with 
69   IA__, may be seen when debugging a GTK+ program.
70
71 * The following functions have been deprecated in GTK+ 2.6:
72   gdk_pango_context_set_colormap
73   gtk_cell_renderer_editing_canceled
74
75 * The new GtkFileChooser widget emphasizes simplicity and thus does 
76   not provide a navigation entry by default when opening files. 
77   Experienced command line users will likely want to make heavy use of
78   the location dialog brought up by the Control-L key shortcut.
79
80 * The GTK+ libraries use an '_' prefix to indicate private symbols that
81   must not be used by applications. On some platforms, symbols beginning 
82   with prefixes such as _gtk, _gdk, and _pango will be exported
83   from the library, on others not. In no case can applications
84   use these private symbols. In addition to that, GTK+ 2.6 makes several
85   symbols private which were not in any installed header files and
86   were never intended to be exported.
87
88 * The gdk_pixbuf_xlib library included in the contrib/ directory 
89   and the framebuffer GDK backend included in the gdk/linux-fb directory
90   of GTK+ are provided on an as-is basis and have not been tested at all. 
91   No guarantees about the degree of workingness or about future
92   compatibility are provided.
93
94 * On Unix, the assumption of GLib and GTK+ by default is that filenames on 
95   the filesystem are encoded in UTF-8 rather than the encoding of the locale;
96   the GTK+ developers consider that having filenames whose interpretation
97   depends on the current locale is fundamentally a bad idea.
98
99   If you have filenames encoded in the encoding of your locale, then you 
100   may want to set the G_FILENAME_ENCODING environment variable:
101   
102    G_FILENAME_ENCODING=@locale
103    export G_FILENAME_ENCODING
104
105   (Earlier versions of GLib 2.x required a different environment variable
106   setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
107   is still supported, but G_FILENAME_ENCODING is preferred.)
108   Best integration of GTK+ 2.6 with the environment is achieved by 
109   using a UTF-8 locale.
110
111   On Windows, filenames passed to GTK+ should always be in UTF-8, as
112   in GLib 2.6. This is different than in previous versions of GTK+
113   where the system codepage was used. As in GLib, for DLL ABI
114   stability, applications built against previous versions of GTK+ will
115   use entry points providing the old semantics.
116
117   When compiling against GTK+ 2.6, applications intended to be
118   portable to Windows must take the UTF-8 file name encoding into
119   consideration, and use the gstdio wrappers to access files whose 
120   names have been constructed from strings returned from GTK+ or GLib.
121
122 How to report bugs
123 ==================
124
125 Bugs should be reported to the GNOME bug tracking system.
126 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
127 account for yourself.
128   
129 In the bug report please include:
130   
131 * Information about your system. For instance:
132
133    - What operating system and version
134    - What version of X
135    - For Linux, what version of the C library
136
137   And anything else you think is relevant.
138
139 * How to reproduce the bug. 
140
141   If you can reproduce it with one of the tests or demos built with GTK+, 
142   such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
143   please include a short test program that exhibits the behavior. As a 
144   last resort, you can also provide a pointer to a larger piece of software 
145   that can be downloaded.
146
147 * If the bug was a crash, the exact text that was printed out when the
148   crash occured.
149
150 * Further information such as stack traces may be useful, but is not
151   necessary. If you do send a stack trace, and the error is an X error,
152   it will be more useful if the stacktrace is produced running the test
153   program with the --sync command line option.
154
155 Patches
156 =======
157
158 Patches should also be submitted to bugzilla.gnome.org. If the patch
159 fixes an existing bug, add the patch as an attachment to that bug
160 report.
161
162 Otherwise, enter a new bug report that describes the patch, and attach
163 the patch to that bug report.
164
165 Bug reports containing patches should include the PATCH keyword in their
166 keyword fields. If the patch adds to or changes the GTK+ programming
167 interface, the API keyword should also be included.
168   
169 Patches should be in unified diff form. (The -u option to GNU diff.)