From 39d1162a0b45bdcd45dc76b3726bcd05c6b40513 Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 24 Aug 2022 17:31:41 +0900 Subject: [PATCH] docs: add Backward Compatibility Notes --- .../backward_compatibility_notes.rst | 16 ++++++++++++++++ user_guide_src/source/installation/upgrading.rst | 4 ++++ 2 files changed, 20 insertions(+) create mode 100644 user_guide_src/source/installation/backward_compatibility_notes.rst diff --git a/user_guide_src/source/installation/backward_compatibility_notes.rst b/user_guide_src/source/installation/backward_compatibility_notes.rst new file mode 100644 index 000000000000..9b7272edf148 --- /dev/null +++ b/user_guide_src/source/installation/backward_compatibility_notes.rst @@ -0,0 +1,16 @@ +############################ +Backward Compatibility Notes +############################ + +We try to develop our products to be as backward compatible (BC) as possible. + +Only major releases (such as 4.0, 5.0 etc.) are allowed to break backward compatibility. +Minor releases (such as 4.2, 4.3 etc.) may introduce new features, but must do so without breaking the existing API. + +However, the code is not mature and bug fixes may break compatibility in minor releases, or even in patch releases (such as 4.2.5). In that case, all the breaking changes are described in the :doc:`../changelogs/index`. + +***************************** +What are not Breaking Changes +***************************** + +- System messages defined in **system/Language/en/** are strictly for internal framework use and are not covered by backwards compatibility (BC) promise. If developers are relying on language string output they should be checking it against the function call (``lang('...')``), not the content. diff --git a/user_guide_src/source/installation/upgrading.rst b/user_guide_src/source/installation/upgrading.rst index 8e89b617fdd5..84695eb58ac2 100644 --- a/user_guide_src/source/installation/upgrading.rst +++ b/user_guide_src/source/installation/upgrading.rst @@ -5,6 +5,8 @@ Upgrading From a Previous Version Please read the upgrade notes corresponding to the version you are upgrading from. +See also :doc:`./backward_compatibility_notes`. + .. note:: If you don't know what version of CodeIgniter you are currently running, you can get it from :ref:`the Debug Toolbar `, or simply echo the constant ``\CodeIgniter\CodeIgniter::CI_VERSION``. @@ -12,6 +14,8 @@ upgrading from. .. toctree:: :titlesonly: + backward_compatibility_notes + upgrade_423 upgrade_422 upgrade_421