From b64c26ad9db0c85fc21c34dde28ba747552f05c9 Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Thu, 16 Dec 2004 17:58:29 +0000 Subject: Updated documentation git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@196 5ecf4fe2-1ee6-0310-87b1-e25e094e27de --- railties/README | 44 +++++++++++++++++++++++++++++++++++++++++++- railties/Rakefile | 2 ++ 2 files changed, 45 insertions(+), 1 deletion(-) (limited to 'railties') diff --git a/railties/README b/railties/README index 4d58c3276c..2c1c9a872d 100644 --- a/railties/README +++ b/railties/README @@ -41,7 +41,7 @@ link:files/vendor/actionpack/README.html. 1. Run the WEBrick servlet: ruby script/server (run with --help for options) 2. Go to http://localhost:3000/ and get "Congratulations, you've put Ruby on Rails!" -3. Follow the guidelines on the "Congratulations, you're on Rails!" screen +3. Follow the guidelines on the "Congratulations, you've put Ruby on Rails!" screen == Example for Apache conf @@ -73,6 +73,48 @@ information to these files. Debugging info will also be shown in the browser on requests from 127.0.0.1. +== Breakpoints + +Breakpoint support is available through the script/breakpointer client. This +means that you can break out of execution at any point in the code, investigate +and change the model, AND then resume execution! Example: + + class WeblogController < ActionController::Base + def index + @posts = Post.find_all + breakpoint "Breaking out from the list" + end + end + +So the controller will accept the action, run the first line, then present you +with a IRB prompt in the breakpointer window. Here you can do things like: + +Executing breakpoint "Breaking out from the list" at .../webrick_server.rb:16 in 'breakpoint' + + >> @posts.inspect + => "[#nil, \"body\"=>nil, \"id\"=>\"1\"}>, + #\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]" + >> @posts.first.title = "hello from a breakpoint" + => "hello from a breakpoint" + +...and even better is that you can examine how your runtime objects actually work: + + >> f = @posts.first + => #nil, "body"=>nil, "id"=>"1"}> + >> f. + Display all 152 possibilities? (y or n) + +Finally, when you're ready to resume execution, you press CTRL-D + + +== Console + +You can interact with the domain model by starting the console through script/console. +Here you'll have all parts of the application configured, just like it is when the +application is running. You can inspect domain models, change values, and save to the +database. Start the script without arguments to see the options. + + == Description of contents app diff --git a/railties/Rakefile b/railties/Rakefile index 1de116b5cd..8c1a06e785 100644 --- a/railties/Rakefile +++ b/railties/Rakefile @@ -224,6 +224,8 @@ spec = Gem::Specification.new do |s| s.add_dependency('actionpack', '>= 0.9.5') s.add_dependency('actionmailer', '>= 0.4.0') + s.has_rdoc = false + s.files = PKG_FILES.to_a.delete_if {|f| f.include?('.svn')} s.require_path = 'lib' -- cgit v1.2.3