blob: 8057a16fd3b78f6d46c3948d6b13f09bd9de329c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<part id="api-breaks">
<title>API Breaks</title>
<para>
gedit is a quite old piece of software (created in 1998, at the beginnings
of the GNOME project), and as every software, the code evolves during its
lifetime. So there are sometimes API breaks for gedit plugins, there are no
API stability guarantees.
</para>
<para>
When it is possible, instead of directly removing an API, that API is first
marked as deprecated, and then removed for the next API break. See the
<link linkend="api-index-deprecated">index of deprecated symbols</link>.
</para>
<refsect1>
<title>3.36.0 -> 3.37.1</title>
<itemizedlist>
<listitem>
<para>
All previously deprecated APIs have been removed.
</para>
</listitem>
<listitem>
<para>
The lockdown support has been removed (for the
org.gnome.desktop.lockdown GSettings). So the
<code>gedit_app_get_lockdown()</code> function has been removed.
</para>
</listitem>
<listitem>
<para>
The <code>GBOOLEAN_TO_POINTER()</code> and
<code>GPOINTER_TO_BOOLEAN()</code> macros have been removed from
<code>gedit-utils.h</code>.
</para>
</listitem>
<listitem>
<para>
The <code>gedit_utils_get_current_workspace()</code>,
<code>gedit_utils_get_window_workspace()</code> and
<code>gedit_utils_get_current_viewport()</code> functions have been
removed because workspaces information is not available on Wayland.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>3.34.0 -> 3.35.2</title>
<itemizedlist>
<listitem>
<para>
All previously deprecated APIs have been removed.
</para>
</listitem>
<listitem>
<para>
The <code>GeditDocument:use-gvfs-metadata</code> property has been
removed. But there was anyway a warning for not using that property in
a gedit plugin.
</para>
</listitem>
<listitem>
<para>
For <link linkend="gedit-document-get-metadata">gedit_document_get_metadata()</link>
and <link linkend="gedit-document-set-metadata">gedit_document_set_metadata()</link>,
the key names should now have the prefix <code>"gedit-"</code> with
possibly an additional namespace for the plugin name, for example
<code>"gedit-spell-foobar"</code>. So the key names are now the same
regardless of the operating system, and the key names should no longer
start with <code>"metadata::"</code>.
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>For previous gedit versions</title>
<para>
See the
<ulink url="https://wiki.gnome.org/Apps/Gedit/Attic/Old_API_Changes">Old API Changes wiki page</ulink>.
</para>
</refsect1>
</part>
|
