@@ -29,15 +29,16 @@ How to Upgrade
29
29
30
30
Before you upgrade, perform the following actions:
31
31
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.
37
32
- Address any breaking changes between the library version
38
33
your application is using and your planned upgrade version in the
39
34
:ref:`Breaking Changes <php-breaking-changes>` section.
40
35
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
+
41
42
.. tip::
42
43
43
44
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
78
79
version of the library. This type of change may prevent your application from working
79
80
properly if not addressed before upgrading the library.
80
81
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.
84
86
85
87
For more information on release changes, see the release notes and associated
86
88
JIRA tickets for each release on `GitHub <https://github.com/mongodb/mongo-php-library/releases>`__.
87
89
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
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
107
91
- This library version introduces the following breaking changes:
108
+ This library version introduces the following compatibility changes:
92
109
93
- - Drops support for {+mdb-server+} 3.6.
110
+ - Drops support for {+mdb-server+} 3.6 in {+php-library+} v1.20
94
111
95
- Version 1.19 and Earlier
96
- ~~~~~~~~~~~~~~~~~~~~~~~~
112
+ .. tip:: Earlier Library Versions
97
113
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