@@ -29,15 +29,16 @@ How to Upgrade
2929
3030Before you upgrade, perform the following actions:
3131
32- - Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions
33- your application connects to and the PHP version your
34- application compiles with. For version compatibility information, see the
35- :ref:`{+php-library+} Compatibility <php-compatibility>`
36- page.
3732- Address any breaking changes between the library version
3833 your application is using and your planned upgrade version in the
3934 :ref:`Breaking Changes <php-breaking-changes>` section.
4035
36+ - Ensure the new {+library-short+} version is compatible with the {+mdb-server+} versions
37+ your application connects to and the PHP version your
38+ application compiles with. For version compatibility information, see the
39+ :ref:`Compatibility Changes <php-compat-changes>` section and the
40+ :ref:`{+php-library+} Compatibility <php-compatibility>` page.
41+
4142.. tip::
4243
4344 To ensure compatibility across {+mdb-server+} versions when
@@ -78,22 +79,38 @@ A breaking change is a change of a convention or a behavior starting in a specif
7879version of the library. This type of change may prevent your application from working
7980properly if not addressed before upgrading the library.
8081
81- The breaking changes in this section are categorized by the library version that introduced
82- them. When upgrading library versions, address all the breaking changes between the current
83- and upgrade versions.
82+ The breaking changes in this section are categorized by the library
83+ version that introduced them. Only major library versions introduce
84+ breaking changes. When upgrading versions, address all
85+ the breaking changes between the current and upgrade versions.
8486
8587For more information on release changes, see the release notes and associated
8688JIRA tickets for each release on `GitHub <https://github.com/mongodb/mongo-php-library/releases>`__.
8789
88- Version 1.20 Breaking Changes
89- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90+ Version 1.0 Breaking Changes
91+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92+
93+ To view breaking changes for this major release, see the
94+ :github:`release notes </mongodb/mongo-php-library/releases/tag/1.0.0>`
95+ on GitHub.
96+
97+ .. _php-compat-changes:
98+
99+ Compatibility Changes
100+ ---------------------
101+
102+ This section describes the {+mdb-server+} and {+language+} compatibility
103+ changes introduced in {+php-library+} version releases.
104+
105+ Version 1.x Compatibility Changes
106+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90107
91- This library version introduces the following breaking changes:
108+ This library version introduces the following compatibility changes:
92109
93- - Drops support for {+mdb-server+} 3.6.
110+ - Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20
94111
95- Version 1.19 and Earlier
96- ~~~~~~~~~~~~~~~~~~~~~~~~
112+ .. tip:: Earlier Library Versions
97113
98- For library versions 1.19 and earlier, see the release notes and associated
99- JIRA tickets for each release on `GitHub <https://github.com/mongodb/mongo-php-library/releases>`__.
114+ To view compatibility changes for {+php-library+} versions 1.19 and earlier, see the
115+ release notes and associated JIRA tickets for each release on `GitHub
116+ <https://github.com/mongodb/mongo-php-library/releases>`__.
0 commit comments