chap-compatibility.xml revision 3b574cd1ee8b7536278db5241e8aef5155e371d3
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2014-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-compatibility'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://docbook.org/ns/docbook
xmlns:xlink='http://www.w3.org/1999/xlink'>
<title>Compatibility</title>
<para>
This chapter covers major changes to existing APIs,
and deprecated and removed APIs.
</para>
<section xml:id="changes">
<title>Major Changes</title>
<!--
<para>
This maintenance release is binary-compatible with
OpenDJ LDAP SDK ${docPreviousVersion}.
It does not introduce major changes.
</para>
-->
<itemizedlist>
<para>
This release introduces the following changes.
</para>
<listitem>
<para>
When specifying a branch in <command>makeldif</command> templates,
you must now also specify the object classes for the branch.
For example, suppose a template creates an organizational unit branch as follows:
</para>
<programlisting language="ldif">
branch: ou=People,[suffix]
</programlisting>
<para>
You now create the organization unit branch as follows:
</para>
<programlisting language="ldif">
branch: ou=People,[suffix]
objectClass: top
objectClass: organizationalUnit
</programlisting>
<para>
For details on writing <command>makeldif</command> templates, see
<link
xlink:show="new"
xlink:href="dev-guide#makeldif-template-5"
xlink:role="http://docbook.org/xlink/role/olink"
>makeldif.template</link>.
</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="deprecation">
<title>Deprecation</title>
<para>
Deprecated APIs are listed in the API Specification, on the
<link
xlink:show="new"
xlink:href="${sdkJavadocBase}index.html?deprecated-list.html"
>Deprecated list</link> page.
</para>
<para>
Deprecated APIs are likely to be removed in a future release.
</para>
</section>
<section xml:id="removals">
<title>Removals</title>
<para>
Nothing has been removed from the public APIs in this release.
</para>
</section>
</chapter>