<?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.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>
</part>
