Update the documentation of new_framework_defaults file with more details about old apps and how you can upgrade to new defaults.

[Kasper Timm Hansen, Prathamesh Sonpatki]

1 files changed, 16 insertions, 13 deletions

diff --git a/railties/lib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults.rb.tt
index 34905e0e27..05c928210b 100644
--- a/railties/lib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults.rb.tt
+++ b/railties/lib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults.rb.tt
@@ -1,33 +1,36 @@
 # Be sure to restart your server when you modify this file.
-# This file contains all the new default configuration options from
-# Rails 5.0.
+#
+# This file contains migration options to ease your Rails 5.0 upgrade.
+# They will be removed in the next major Rails version.
+#
+# Flip the defaults to the value of past versions then once upgraded
+# begin migrating to the new default one by one.
+#
+# Read the Rails 5.0 release notes for more info on each option.
 <%- unless options[:api] -%>
 
-# Enable per-form CSRF tokens.
+# Enable per-form CSRF tokens. This is new feature of Rails 5.
 Rails.application.config.action_controller.per_form_csrf_tokens = true
 
-# Enable origin-checking CSRF mitigation.
+# Enable origin-checking CSRF mitigation. This is new feature of Rails 5.
 Rails.application.config.action_controller.forgery_protection_origin_check = true
 <%- end -%>
 
+# Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`.
+ActiveSupport.to_time_preserves_timezone = true
+
 # Following config options are introduced to ensure that apps
 # made on earlier versions of Rails are not affected when upgrading.
 <%- unless options[:skip_active_record] -%>
 
-# Require `belongs_to` associations by default.
+# Require `belongs_to` associations by default. Previous versions had false.
 Rails.application.config.active_record.belongs_to_required_by_default = <%= options[:update] ? false : true %>
 <%- end -%>
 
-# Do not halt callback chains when a callback returns false.
+# Do not halt callback chains when a callback returns false. Previous versions had true.
 ActiveSupport.halt_callback_chains_on_return_false = <%= options[:update] ? true : false %>
 <%- unless options[:update] -%>
 
-# Configure SSL options to enable HSTS with subdomains.
+# Configure SSL options to enable HSTS with subdomains. Previous versions had false.
 Rails.application.config.ssl_options = { hsts: { subdomains: true } }
 <%- end -%>
-
-# Preserve the timezone of the receiver when calling to `to_time`.
-# Ruby 2.4 will change the behavior of `to_time` to preserve the timezone
-# when converting to an instance of `Time` instead of the previous behavior
-# of converting to the local system timezone.
-ActiveSupport.to_time_preserves_timezone = true