From 01fdb7949f726a3723da0d27a8978f23bc37f00e Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Fri, 9 Sep 2016 13:54:54 +1200 Subject: [PATCH] Clarify upgrader docs --- docs/en/04_Changelogs/4.0.0.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/04_Changelogs/4.0.0.md b/docs/en/04_Changelogs/4.0.0.md index 4057e7f90..259b347c2 100644 --- a/docs/en/04_Changelogs/4.0.0.md +++ b/docs/en/04_Changelogs/4.0.0.md @@ -60,12 +60,8 @@ as a standard first point of upgrade. #### Upgrade references to renamed and namespaced classes -4.0 moves many classes to namespaces, and renames many methods. -A tool is available to (semi-)automatically update your 3.x code to the new 4.0 names. - -See https://github.com/silverstripe/silverstripe-upgrader/ for the latest documentation on -how to upgrade your code. Typically the process will be: - +Nearly all core PHP classes have been namespaced. For example, `DataObject` is now called `SilverStripe\ORM\DataObject`. +We have developed an [upgrader tool](https://github.com/silverstripe/silverstripe-upgrader/) to (semi-)automatically update your 3.x code to the new naming. Here's an example how to upgrade your `mysite` folder: composer global require silverstripe/upgrader cd ~/Project/Root @@ -75,8 +71,12 @@ how to upgrade your code. Typically the process will be: If you want to do a dry-run, omit the `--write` option to see a preview of a diff of all changed project files. -This will resolve the majority of upgrading work, but for specific changes that will -require manual intervention, please see the below upgrading notes. +This will resolve the majority of upgrading work, but we strongly recommend reviewing the diff +running some regression testing on your functionality. SilverStripe core classes can be referenced +in your PHP files, but also in YAML configuration and SilverStripe templates. +For a full list of renamed classes, check the `.upgrade.yml` definitions in each module. + +The rename won't affect class-based permission codes or database table names. #### Upgrade template locations and references