r2951@asus: jeremy | 2005-07-08 18:09:30 -0700

 Courtenay documentation and error message patches.
 r2952@asus:  jeremy | 2005-07-08 18:43:10 -0700
 Document environment config files.
 r2955@asus:  jeremy | 2005-07-08 19:00:26 -0700
 Updated changelog


git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@1775 5ecf4fe2-1ee6-0310-87b1-e25e094e27de

5 files changed, 48 insertions, 5 deletions

diff --git a/railties/CHANGELOG b/railties/CHANGELOG
index 08b17939fd..baa326703d 100644
--- a/railties/CHANGELOG
+++ b/railties/CHANGELOG
@@ -1,3 +1,7 @@
+*SVN*
+
+* Improved documentation for environment config files.  #1625 [court3nay@gmail.com]
+
 *0.13.0*
 
 * Changed the default logging level in config/environment.rb to INFO for production (so SQL statements won't be logged)
diff --git a/railties/environments/development.rb b/railties/environments/development.rb
index aab4562a51..d214c666d0 100644
--- a/railties/environments/development.rb
+++ b/railties/environments/development.rb
@@ -1,6 +1,14 @@
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+
+# Log error messages when you accidentally call methods on nil.
 require 'active_support/whiny_nil'
 
+# Reload code; show full error reports; disable caching.
 Dependencies.mechanism                             = :load
 ActionController::Base.consider_all_requests_local = true
 ActionController::Base.perform_caching             = false
-BREAKPOINT_SERVER_PORT = 42531
\ No newline at end of file
+
+# The breakpoint server port that script/breakpointer connects to.
+BREAKPOINT_SERVER_PORT = 42531
diff --git a/railties/environments/environment.rb b/railties/environments/environment.rb
index 46363a2b21..45fd0d4165 100644
--- a/railties/environments/environment.rb
+++ b/railties/environments/environment.rb
@@ -1,8 +1,20 @@
-RAILS_ROOT = File.dirname(__FILE__) + "/../"
+# Load the Rails framework and configure your application.
+# You can include your own configuration at the end of this file.
+#
+# Be sure to restart your webserver when you modify this file.
+
+# The path to the root directory of your application.
+RAILS_ROOT = File.join(File.dirname(__FILE__), '..')
+
+# The environment your application is currently running.  Don't set
+# this here; put it in your webserver's configuration as the RAILS_ENV
+# environment variable instead.
+#
+# See config/environments/*.rb for environment-specific configuration.
 RAILS_ENV  = ENV['RAILS_ENV'] || 'development'
 
 
-# Mocks first.
+# Load the Rails framework.  Mock classes for testing come first.
 ADDITIONAL_LOAD_PATHS = ["#{RAILS_ROOT}/test/mocks/#{RAILS_ENV}"]
 
 # Then model subdirectories.
@@ -62,6 +74,8 @@ end
 
 [ActiveRecord, ActionController, ActionMailer].each { |mod| mod::Base.logger ||= RAILS_DEFAULT_LOGGER }
 [ActionController, ActionMailer].each { |mod| mod::Base.template_root ||= "#{RAILS_ROOT}/app/views/" }
+
+# Set up routes.
 ActionController::Routing::Routes.reload
 
 Controllers = Dependencies::LoadingModule.root(
@@ -70,3 +84,4 @@ Controllers = Dependencies::LoadingModule.root(
 )
 
 # Include your app's configuration here:
+
diff --git a/railties/environments/production.rb b/railties/environments/production.rb
index b464250bef..4fc13b05ed 100644
--- a/railties/environments/production.rb
+++ b/railties/environments/production.rb
@@ -1,3 +1,8 @@
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests, full error reports are disabled,
+# and caching is turned on.
+
+# Don't reload code; don't show full error reports; enable caching.
 Dependencies.mechanism                             = :require
 ActionController::Base.consider_all_requests_local = false
-ActionController::Base.perform_caching             = true
\ No newline at end of file
+ActionController::Base.perform_caching             = true
diff --git a/railties/environments/test.rb b/railties/environments/test.rb
index 8c8746c4a0..fea6fdff42 100644
--- a/railties/environments/test.rb
+++ b/railties/environments/test.rb
@@ -1,6 +1,17 @@
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+
+# Log error messages when you accidentally call methods on nil.
 require 'active_support/whiny_nil'
 
+# Don't reload code; show full error reports; disable caching.
 Dependencies.mechanism                             = :require
 ActionController::Base.consider_all_requests_local = true
 ActionController::Base.perform_caching             = false
-ActionMailer::Base.delivery_method                 = :test
\ No newline at end of file
+
+# Tell ActionMailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+ActionMailer::Base.delivery_method                 = :test