[TASK] Add first documentation of breaking changes 53/31853/7
authorChristian Kuhn <lolli@schwarzbu.ch>
Sat, 26 Jul 2014 14:50:12 +0000 (16:50 +0200)
committerHelmut Hummel <helmut.hummel@typo3.org>
Sat, 26 Jul 2014 20:07:57 +0000 (22:07 +0200)
For better documentation of important changes a new file structure
is introduced that substitutes the old NEWS.md file. Some recent
changes are already added with this change as examples, but all
patches since 6.2 release need a post-merge review to see which
further patches need documentation. In future, changelog files for
important changes should be provided together with the patch that
introduces the change.

Resolves: #60186
Resolves: #59741
Resolves: #59740
Releases: master
Change-Id: I6e154262ed49542a5b15e7c68313c9f11dea5fe5
Reviewed-on: http://review.typo3.org/31853
Reviewed-by: Susanne Moog <typo3@susannemoog.de>
Tested-by: Susanne Moog <typo3@susannemoog.de>
Reviewed-by: Ernesto Baschny <ernst@cron-it.de>
Tested-by: Ernesto Baschny <ernst@cron-it.de>
Reviewed-by: Helmut Hummel <helmut.hummel@typo3.org>
Tested-by: Helmut Hummel <helmut.hummel@typo3.org>
14 files changed:
NEWS.md
typo3/sysext/backend/Classes/Controller/LoginController.php
typo3/sysext/core/Documentation/Changelog/.htaccess [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/Howto.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-42543-DefaultTypoScriptRemoved.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-60063-FeloginPluginFileRemoved.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-DroppedBackendLoginOptions.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-T3skinBackendLoginJavascriptFileMoved.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-T3skinBackendLoginTemplateMoved.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-60561-DefaultTypoScriptConstantsRemoved.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Breaking-60582-RsaauthJavascriptFilesMoved.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Deprecation-60559-MakeLoginBoxImage.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Feature-60064-LoggingFrameworkIntrospectionProcessor.rst [new file with mode: 0644]
typo3/sysext/core/Documentation/Changelog/master/Feature-60567-ShowStylesSegmentInTypoScriptObjectBrowser.rst [new file with mode: 0644]

diff --git a/NEWS.md b/NEWS.md
index 3716914..612479c 100644 (file)
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,66 +1,5 @@
-TYPO3 CMS 6.3 - WHAT'S NEW
-==========================
-
-TYPO3 is an open source PHP based web content management system released
-under the GNU GPL. TYPO3 is copyright (c) 1999-2014 by Kasper Skaarhoj.
-
-This document provides information about what is new in the 6.3 release
-of TYPO3. An up-to-date version of this document also containing links to
-further in depth information can be found here:
-
-http://wiki.typo3.org/TYPO3_CMS_6.3
-
-System requirement changes
---------------------------
-
-Consult INSTALL.md for complete system requirements.
-
-
-Changes and Improvements
-------------------------
-
-
-
-### Removed and moved components
-
-
-
-### General
-
-
-
-### Logging
-
-
-
-### Backend
-
-
-
-#### CSS Styled Content
-
-
-
-#### Caching
-
-
-
-### Frontend
-
-
-
-### Administration / Customization
-
-
-
-### Extbase
-
-
-
-### Fluid
-
-
-
-### System categories
-
+TYPO3 CMS - WHAT'S NEW
+======================
 
+This file was superseded by the files located in
+typo3/sysext/core/Documentation/Changelog/
index 380be5b..bb6494f 100644 (file)
@@ -470,7 +470,7 @@ class LoginController {
         * Returns the login box image, whether the default or an image from the rotation folder.
         *
         * @return string HTML image tag.
-        * @deprecated since 6.3, will be removed
+        * @deprecated since 7, see Deprecation-60559-MakeLoginBoxImage.rst
         */
        public function makeLoginBoxImage() {
                GeneralUtility::logDeprecatedFunction();
diff --git a/typo3/sysext/core/Documentation/Changelog/.htaccess b/typo3/sysext/core/Documentation/Changelog/.htaccess
new file mode 100644 (file)
index 0000000..3418e55
--- /dev/null
@@ -0,0 +1 @@
+deny from all
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/Howto.rst b/typo3/sysext/core/Documentation/Changelog/Howto.rst
new file mode 100644 (file)
index 0000000..29eae0c
--- /dev/null
@@ -0,0 +1,76 @@
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   master/*
+
+============================================================
+Documentation of breaking changes, deprecations and features
+============================================================
+
+
+Motivation and goals
+====================
+
+Spreading information about important core changes has been a problematic issue ever since. With the switch to the
+new release cycle with version 7 of the TYPO3 CMS core this situation should be improved.
+
+A dedicated changelog of important changes is established to inform users, developers and other core related
+teams or projects:
+
+ - Overview for documentation team which changes trigger documentation changes.
+
+ - Overview for Release Managers and other "Spread the word" related works on important changes.
+
+ - Hints for extension developers, integrators and project developers whose own code areas may need adjustments on core updates.
+
+ - Standardized format for easy usage in scripts like a core migration or release notes system.
+
+This new structure also replaces the NEWS.md file.
+
+Different changelog types
+=========================
+
+A changelog handles one of these change types:
+
+ - Breaking change: A patch moved or removed a specific part of core functionality that may break extensions if they use this part. Removal of deprecated code or an interface change are good examples of this type.
+
+ - Deprecation: A patch deprecates a certain core functionality for a planned removal.
+
+ - Feature: A patch adds new functionality.
+
+Casual bug fixes do not need changelog files, but every change that may be of special interest for extension developers
+or documentation writers should receive an entry. The changelog file must be provided as part of the patch that
+introduces the change.
+
+
+Location
+========
+
+New changelog files should be added to the "master" directory. If a version is to be released, all files in this directory
+will be moved to a directory that is named after the release number. This way it can be easily seen which change was
+introduced in which released core version.
+
+
+Filename convention
+===================
+
+<type>-<forgeIssueNumber>-<UpperCamelCaseDescription>.rst
+
+
+File content
+============
+
+Like other documentation, changelog files are done in ReST, see `TYPO3 wiki ReST syntax`_ for more details.
+
+ - All types contain a "Description" section that should give a short summary on which core part was affected by the change.
+
+ - All types contain an "Impact" section that describes the possible impact of a change. An example is "Frontend output may change", "Configuration of xy is easier" or "Backend will throw a fatal error".
+
+ - Types "Deprecation" and "Breaking" contain an "Affected installations" section that describes when and if a TYPO3 instance is affected by a change. Example: "Extension xy is in use" or "TypoScript functionality xy is used" or "System is based on PHP 5.3".
+
+ - Types "Deprecation" and "Breaking" contain a "Migration" section to describe best practices on how to cope with a specific change.
+
+.. _TYPO3 wiki ReST syntax: http://wiki.typo3.org/ReST_Syntax
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-42543-DefaultTypoScriptRemoved.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-42543-DefaultTypoScriptRemoved.rst
new file mode 100644 (file)
index 0000000..b1d0e5c
--- /dev/null
@@ -0,0 +1,45 @@
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+
+   :class:  typoscript
+
+============================================================
+Breaking: #42543 - Default TypoScript Removed
+============================================================
+
+Description
+===========
+
+The default TypoScript :ts:`styles.insertContent` was removed without substitution.
+
+
+Impact
+======
+
+Frontend output may change.
+
+
+Affected installations
+======================
+
+A TYPO3 instance is affected if own TypoScript operates with :ts:`styles.insertContent`. This is pretty unlikely since the styles segment was hidden in the TypoScript Object Browser.
+
+
+Migration
+=========
+
+Either remove usage of :ts:`styles.insertContent` or add a snippet at an early point in TypoScript for backwards compatibility.
+
+::
+
+  styles.insertContent = CONTENT
+  styles.insertContent {
+    table = tt_content
+    select {
+      orderBy = sorting
+      where = colPos=0
+      languageField = sys_language_uid
+    }
+  }
+
+..
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-60063-FeloginPluginFileRemoved.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-60063-FeloginPluginFileRemoved.rst
new file mode 100644 (file)
index 0000000..0812eef
--- /dev/null
@@ -0,0 +1,28 @@
+=========================================
+Breaking: #60063 - Felogin Plugin Removed
+=========================================
+
+Description
+===========
+
+File EXT:felogin/pi1/class.tx_felogin_pi1.php was removed.
+
+
+Impact
+======
+
+ - A require in PHP of this file throws a fatal error.
+
+ - An includeLibs TypoScript setting to this file raises a warning.
+
+
+Affected installations
+======================
+
+A TYPO3 instance is affected if a 3rd party extension requires EXT:felogin/pi1/class.tx_felogin_pi1.php or if an includeLibs TypoScript setting to this file is set.
+
+
+Migration
+=========
+
+Remove the require line in PHP and includeLibs line in TypoScript, they are obsolete.
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-DroppedBackendLoginOptions.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-DroppedBackendLoginOptions.rst
new file mode 100644 (file)
index 0000000..a19a8a1
--- /dev/null
@@ -0,0 +1,27 @@
+================================================
+Breaking: #60559 - Dropped Backend Login Options
+================================================
+
+Description
+===========
+
+Handling of $GLOBALS['TBE_STYLES']['loginBoxImage_rotationFolder'] and $GLOBALS['TBE_STYLES']['loginBoxImage_author'] was dropped.
+
+
+Impact
+======
+
+Setting those options has no effect anymore.
+
+
+Affected installations
+======================
+
+These options had no effect with standard core internal login screen based on t3skin for a long time already. Instances are
+only affected if a 3rd party extension is loaded that changes the backend login screen and operates with these settings.
+
+
+Migration
+=========
+
+Remove these options and their usage from the affected 3rd party extension or unload the extension.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-T3skinBackendLoginJavascriptFileMoved.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-T3skinBackendLoginJavascriptFileMoved.rst
new file mode 100644 (file)
index 0000000..a351e34
--- /dev/null
@@ -0,0 +1,27 @@
+=============================================================
+Breaking: #60559 - T3skin Backend Login Javascript File Moved
+=============================================================
+
+Description
+===========
+
+Javascript files of the backend login form moved from EXT:t3skin to EXT:backend.
+
+
+Impact
+======
+
+Javascript or file not found errors.
+
+
+Affected installations
+======================
+
+An installation is affected if a 3rd party extension includes EXT:t3skin/Resources/Public/JavaScript/login.js
+
+
+Migration
+=========
+
+Include EXT:backend/Resources/Public/JavaScript/login.js instead or refactor the affected extension to free it
+from the dependency to this core internal file.
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-T3skinBackendLoginTemplateMoved.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-60559-T3skinBackendLoginTemplateMoved.rst
new file mode 100644 (file)
index 0000000..38991a6
--- /dev/null
@@ -0,0 +1,27 @@
+===========================================================
+Breaking: #60559 - T3skin Backend Login Template File Moved
+===========================================================
+
+Description
+===========
+
+The HTML template file for the backend login screen was moved from EXT:t3skin to EXT:backend.
+
+
+Impact
+======
+
+Broken login screen.
+
+
+Affected installations
+======================
+
+A TYPO3 instance is affected if a 3rd party extension uses file EXT:t3skin/Resources/Private/Templates/login.html
+
+
+Migration
+=========
+
+Use file EXT:backend/Resources/Private/Templates/login.html instead or refactor the affected extension to free it
+from the dependency to this core internal file.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-60561-DefaultTypoScriptConstantsRemoved.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-60561-DefaultTypoScriptConstantsRemoved.rst
new file mode 100644 (file)
index 0000000..ae8f31a
--- /dev/null
@@ -0,0 +1,48 @@
+.. role::   typoscript(code)
+.. role::   ts(typoscript)
+:class:  typoscript
+
+=======================================================
+Breaking: #60561 - Default TypoScript Constants Removed
+=======================================================
+
+Description
+===========
+
+These default TypoScript constants were dropped:
+
+ - :ts:`{$_clear}`
+ - :ts:`{$_blackBorderWrap}
+ - :ts:`{$_tableWrap}`
+ - :ts:`{$_tableWrap_DEBUG}`
+ - :ts:`{$_stdFrameParams}`
+ - :ts:`{$_stdFramesetParams}`
+
+
+Impact
+======
+
+Frontend output may change.
+
+
+Affected installations
+======================
+
+A TYPO3 instance is affected if own TypoScript uses the above mentioned TypoScript constants.
+
+
+Migration
+=========
+
+Either remove usage of the above constants or add a snippet at an early point in TypoScript for backwards compatibility.
+
+::
+
+  _clear = <img src="clear.gif" width="1" height="1" alt="" />
+  _blackBorderWrap = <table border="0" bgcolor="black" cellspacing="0" cellpadding="1"><tr><td> | </td></tr></table>
+  _tableWrap = <table border="0" cellspacing="0" cellpadding="0"> | </table>
+  _tableWrap_DEBUG = <table border="1" cellspacing="0" cellpadding="0"> | </table>
+  _stdFrameParams = frameborder="no" marginheight="0" marginwidth="0" noresize="noresize"
+  _stdFramesetParams = 'border="0" framespacing="0" frameborder="no"
+
+..
\ No newline at end of file
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Breaking-60582-RsaauthJavascriptFilesMoved.rst b/typo3/sysext/core/Documentation/Changelog/master/Breaking-60582-RsaauthJavascriptFilesMoved.rst
new file mode 100644 (file)
index 0000000..f958c01
--- /dev/null
@@ -0,0 +1,26 @@
+=================================================
+Breaking: #60582 - Rsaauth Javascript Files Moved
+=================================================
+
+Description
+===========
+
+Javascript files from EXT:rsaauth were moved from resources/ to Resources/Public/JavaScript.
+
+
+Impact
+======
+
+Javascript or file not found errors.
+
+
+Affected installations
+======================
+
+An installation is affected if a 3rd party extension includes Javascript files from rsaauth.
+
+
+Migration
+=========
+
+Change affected extension to include Javascript files from resources/ to Resources/Public/JavaScript/.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-60559-MakeLoginBoxImage.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-60559-MakeLoginBoxImage.rst
new file mode 100644 (file)
index 0000000..4197151
--- /dev/null
@@ -0,0 +1,28 @@
+=========================================
+Deprecation: #60559 - makeLoginBoxImage()
+=========================================
+
+Description
+===========
+
+Method TYPO3\CMS\Backend\Controller::makeLoginBoxImage() is deprecated.
+
+
+Impact
+======
+
+Backend login images are not rendered any longer. The method body is empty and does not return rendered HTML any longer.
+
+
+Affected installations
+======================
+
+The method was unused with default backend login screen for a long time already, an installation is only affected if a
+3rd party extension is loaded that changes the default login screen and uses makeLoginBoxImage() or the template marker
+LOGINBOX_IMAGE.
+
+
+Migration
+=========
+
+Free an affected 3rd party extension from usage of this method or unload the extension.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Feature-60064-LoggingFrameworkIntrospectionProcessor.rst b/typo3/sysext/core/Documentation/Changelog/master/Feature-60064-LoggingFrameworkIntrospectionProcessor.rst
new file mode 100644 (file)
index 0000000..7f451ef
--- /dev/null
@@ -0,0 +1,20 @@
+===========================================================
+Feature: #60064 - Logging Framework Introspection Processor
+===========================================================
+
+Description
+===========
+
+The introspection processor of the logging framework was extended to log the full PHP backtrace and not only the last
+element of a backtrace.
+
+Two options were added to enable this feature:
+
+ - :code:`appendFullBackTrace`, boolean, not mandatory` Add full backtrace to the log
+
+ - :code:`shiftBackTraceLevel`, integer, default 0, not mandatory` Removes the given number of entries from the top of the backtrace stack.
+
+Impact
+======
+
+The introspection processor behaves as before as long as the feature is not explicitly configured.
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Feature-60567-ShowStylesSegmentInTypoScriptObjectBrowser.rst b/typo3/sysext/core/Documentation/Changelog/master/Feature-60567-ShowStylesSegmentInTypoScriptObjectBrowser.rst
new file mode 100644 (file)
index 0000000..2f6a7f4
--- /dev/null
@@ -0,0 +1,14 @@
+==========================================================
+Feature: #60567 - Show Styles Segment in TS Object Browser
+==========================================================
+
+Description
+===========
+
+The TypoScript Object Browser now shows the setup segment :ts:`styles.`
+
+
+Impact
+======
+
+The segment is cached in the Frontend and not unset anymore, page cache entries increase slightly in size.