public
Description: PLEASE CHECK http://github.com/lifo/docrails/wikis
Homepage: http://weblog.rubyonrails.org/2008/5/2/help-improve-rails-documentation-on-git-branch
Clone URL: git://github.com/lifo/docrails.git
Fix typos
lifo (author)
Fri Jan 09 20:43:14 -0800 2009
commit  29664f582c93aa9efaa91e347646159ebe359f05
tree    403f58c1130b8f1bf85fa860e9aa538a7e4e0ad4
parent  2b384df218365f70f36ccf746d1bffe063ff09a6
...
284
285
286
287
 
288
289
290
...
418
419
420
421
 
422
423
424
...
429
430
431
432
 
433
434
435
...
534
535
536
537
 
538
539
 
540
541
542
543
 
544
545
546
...
552
553
554
555
 
556
557
558
...
592
593
594
595
 
596
597
598
...
648
649
650
651
 
652
653
654
...
684
685
686
687
 
688
689
690
...
284
285
286
 
287
288
289
290
...
418
419
420
 
421
422
423
424
...
429
430
431
 
432
433
434
435
...
534
535
536
 
537
538
 
539
540
541
542
 
543
544
545
546
...
552
553
554
 
555
556
557
558
...
592
593
594
 
595
596
597
598
...
648
649
650
 
651
652
653
654
...
684
685
686
 
687
688
689
690
0
@@ -284,7 +284,7 @@ Learn about various tools facilitating benchmarking and profiling
0
 </p>
0
 </li>
0
 </ul></div>
0
-<div class="paragraph"><p>Performance testing is an integral part of the development cycle. It is very important that you don&#8217;t make your end users wait for too long before the page is completely loaded. Ensuring a plesant browsing experience to the end users and cutting cost of unnecessary hardwares is important for any web application.</p></div>
0
+<div class="paragraph"><p>Performance testing is an integral part of the development cycle. It is very important that you don&#8217;t make your end users wait for too long before the page is completely loaded. Ensuring a pleasant browsing experience to the end users and cutting cost of unnecessary hardwares is important for any web application.</p></div>
0
 </div>
0
 </div>
0
 <h2 id="_performance_test_cases">1. Performance Test Cases</h2>
0
@@ -418,7 +418,7 @@ http://www.gnu.org/software/src-highlite -->
0
   <span style="font-weight: bold"><span style="color: #0000FF">end</span></span>
0
 <span style="font-weight: bold"><span style="color: #0000FF">end</span></span></tt></pre></div></div>
0
 <h3 id="_modes">1.3. Modes</h3>
0
-<div class="paragraph"><p>Performance tests can be run in two modes : Benchmarking and Profling.</p></div>
0
+<div class="paragraph"><p>Performance tests can be run in two modes : Benchmarking and Profiling.</p></div>
0
 <h4 id="_benchmarking">1.3.1. Benchmarking</h4>
0
 <div class="paragraph"><p>Benchmarking helps find out how fast is a performance test. Each test case is run <tt>4 times</tt> in benchmarking mode.</p></div>
0
 <div class="paragraph"><p>To run performance tests in benchmarking mode:</p></div>
0
@@ -429,7 +429,7 @@ http://www.lorenzobettini.it
0
 http://www.gnu.org/software/src-highlite -->
0
 <pre><tt>$ rake <span style="font-weight: bold"><span style="color: #0000FF">test</span></span><span style="color: #990000">:</span>benchmark</tt></pre></div></div>
0
 <h4 id="_profiling">1.3.2. Profiling</h4>
0
-<div class="paragraph"><p>Profiling helps you introspect into a performance test and provide an in-depth picture of the slow and memory hungy parts. Each Test case is run <tt>1 time</tt> in profiling mode.</p></div>
0
+<div class="paragraph"><p>Profiling helps you introspect into a performance test and provide an in-depth picture of the slow and memory hungry parts. Each Test case is run <tt>1 time</tt> in profiling mode.</p></div>
0
 <div class="paragraph"><p>To run performance tests in profiling mode:</p></div>
0
 <div class="listingblock">
0
 <div class="content"><!-- Generator: GNU source-highlight 2.9
0
@@ -534,13 +534,13 @@ http://www.gnu.org/software/src-highlite -->
0
               memory<span style="color: #990000">:</span> <span style="color: #993399">832.13</span> KB
0
              objects<span style="color: #990000">:</span> <span style="color: #993399">7882</span></tt></pre></div></div>
0
 <h5 id="_flat">Flat</h5>
0
-<div class="paragraph"><p>Flat output shows the total amount of time spent in each method. <a href="http://ruby-prof.rubyforge.org/files/examples/flat_txt.html">Check ruby prof documentation for a better explaination</a>.</p></div>
0
+<div class="paragraph"><p>Flat output shows the total amount of time spent in each method. <a href="http://ruby-prof.rubyforge.org/files/examples/flat_txt.html">Check ruby prof documentation for a better explanation</a>.</p></div>
0
 <h5 id="_graph">Graph</h5>
0
-<div class="paragraph"><p>Graph output shows how long each method takes to run, which methods call it and which methods it calls. <a href="http://ruby-prof.rubyforge.org/files/examples/graph_txt.html">Check ruby prof documentation for a better explaination</a>.</p></div>
0
+<div class="paragraph"><p>Graph output shows how long each method takes to run, which methods call it and which methods it calls. <a href="http://ruby-prof.rubyforge.org/files/examples/graph_txt.html">Check ruby prof documentation for a better explanation</a>.</p></div>
0
 <h5 id="_tree">Tree</h5>
0
 <div class="paragraph"><p>Tree output is profiling information in calltree format for use by <a href="http://kcachegrind.sourceforge.net/html/Home.html">kcachegrind</a> and similar tools.</p></div>
0
 <h3 id="_tuning_test_runs">1.6. Tuning Test Runs</h3>
0
-<div class="paragraph"><p>By default, each performance test is run <tt>4 times</tt> in benchmarking model and <tt>1 time</tt> in profiling. However, test runs can easily be configured.</p></div>
0
+<div class="paragraph"><p>By default, each performance test is run <tt>4 times</tt> in benchmarking mode and <tt>1 time</tt> in profiling. However, test runs can easily be configured.</p></div>
0
 <div class="admonitionblock">
0
 <table><tr>
0
 <td class="icon">
0
@@ -552,7 +552,7 @@ http://www.gnu.org/software/src-highlite -->
0
 <h3 id="gc">1.7. Installing GC Patched Ruby</h3>
0
 <div class="paragraph"><p>To get the best from Rails performance tests, you need to build a special Ruby binary with some super powers - <a href="http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch">GC patch</a> for measuring GC Runs/Time and memory/object allocation.</p></div>
0
 <div class="paragraph"><p>The process is fairly straight forward. If you&#8217;ve never compiled a Ruby binary before, follow the following steps to build a ruby binary inside your home directory:</p></div>
0
-<h4 id="_instllation">1.7.1. Instllation</h4>
0
+<h4 id="_installation">1.7.1. Installation</h4>
0
 <div class="paragraph"><p>Compile Ruby and apply this <a href="http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch">GC Patch</a>:</p></div>
0
 <h4 id="_download_and_extract">1.7.2. Download and Extract</h4>
0
 <div class="listingblock">
0
@@ -592,7 +592,7 @@ alias gcrails='~/rubygc/bin/rails'</tt></pre>
0
 </div></div>
0
 <h4 id="_install_rubygems_and_dependency_gems">1.7.6. Install rubygems and dependency gems</h4>
0
 <div class="paragraph"><p>Download <a href="http://rubyforge.org/projects/rubygems">Rubygems</a> and install it from source. Rubygem&#8217;s README file should have necessary installation instructions.</p></div>
0
-<div class="paragraph"><p>Additionally, installa the following gems :</p></div>
0
+<div class="paragraph"><p>Additionally, install the following gems :</p></div>
0
 <div class="ulist"><ul>
0
 <li>
0
 <p>
0
@@ -648,7 +648,7 @@ http://www.gnu.org/software/src-highlite -->
0
 by Lorenzo Bettini
0
 http://www.lorenzobettini.it
0
 http://www.gnu.org/software/src-highlite -->
0
-<pre><tt>Creating projectem <span style="color: #990000">(</span><span style="color: #993399">185</span><span style="color: #990000">.</span>3ms<span style="color: #990000">)</span></tt></pre></div></div>
0
+<pre><tt>Creating project <span style="color: #990000">(</span><span style="color: #993399">185</span><span style="color: #990000">.</span>3ms<span style="color: #990000">)</span></tt></pre></div></div>
0
 <div class="paragraph"><p>Please refer to <a href="http://api.rubyonrails.com/classes/ActiveRecord/Base.html#M001336">API docs</a> for optional options to <tt>benchmark()</tt></p></div>
0
 <h3 id="_controller">2.2. Controller</h3>
0
 <div class="paragraph"><p>Similarly, you could use this helper method inside <a href="http://api.rubyonrails.com/classes/ActionController/Benchmarking/ClassMethods.html#M000715">controllers</a></p></div>
0
@@ -684,7 +684,7 @@ http://www.gnu.org/software/src-highlite -->
0
 </div>
0
 <h2 id="_request_logging">3. Request Logging</h2>
0
 <div class="sectionbody">
0
-<div class="paragraph"><p>Rails log files containt very useful information about the time taken to serve each request. Here&#8217;s a typical log file entry:</p></div>
0
+<div class="paragraph"><p>Rails log files contain very useful information about the time taken to serve each request. Here&#8217;s a typical log file entry:</p></div>
0
 <div class="listingblock">
0
 <div class="content"><!-- Generator: GNU source-highlight 2.9
0
 by Lorenzo Bettini
...
9
10
11
12
 
13
14
15
...
152
153
154
155
 
156
157
158
...
167
168
169
170
 
171
172
173
...
283
284
285
286
 
287
288
289
290
 
291
292
293
...
295
296
297
298
 
299
300
301
...
306
307
308
309
 
310
311
312
...
353
354
355
356
 
357
358
359
...
389
390
391
392
 
393
394
395
...
423
424
425
426
 
427
428
429
...
9
10
11
 
12
13
14
15
...
152
153
154
 
155
156
157
158
...
167
168
169
 
170
171
172
173
...
283
284
285
 
286
287
288
289
 
290
291
292
293
...
295
296
297
 
298
299
300
301
...
306
307
308
 
309
310
311
312
...
353
354
355
 
356
357
358
359
...
389
390
391
 
392
393
394
395
...
423
424
425
 
426
427
428
429
0
@@ -9,7 +9,7 @@ This guide covers the various ways of performance testing a Ruby on Rails applic
0
 * Understand the information provided by Rails inside the log files
0
 * Learn about various tools facilitating benchmarking and profiling
0
 
0
-Performance testing is an integral part of the development cycle. It is very important that you don't make your end users wait for too long before the page is completely loaded. Ensuring a plesant browsing experience to the end users and cutting cost of unnecessary hardwares is important for any web application.
0
+Performance testing is an integral part of the development cycle. It is very important that you don't make your end users wait for too long before the page is completely loaded. Ensuring a pleasant browsing experience to the end users and cutting cost of unnecessary hardwares is important for any web application.
0
 
0
 == Performance Test Cases ==
0
 
0
@@ -152,7 +152,7 @@ end
0
 
0
 === Modes ===
0
 
0
-Performance tests can be run in two modes : Benchmarking and Profling.
0
+Performance tests can be run in two modes : Benchmarking and Profiling.
0
 
0
 ==== Benchmarking ====
0
 
0
@@ -167,7 +167,7 @@ $ rake test:benchmark
0
 
0
 ==== Profiling ====
0
 
0
-Profiling helps you introspect into a performance test and provide an in-depth picture of the slow and memory hungy parts. Each Test case is run +1 time+ in profiling mode. 
0
+Profiling helps you introspect into a performance test and provide an in-depth picture of the slow and memory hungry parts. Each Test case is run +1 time+ in profiling mode. 
0
 
0
 To run performance tests in profiling mode:
0
 
0
@@ -283,11 +283,11 @@ BrowsingTest#test_homepage (58 ms warmup)
0
 
0
 ===== Flat =====
0
 
0
-Flat output shows the total amount of time spent in each method. http://ruby-prof.rubyforge.org/files/examples/flat_txt.html[Check ruby prof documentation for a better explaination].
0
+Flat output shows the total amount of time spent in each method. http://ruby-prof.rubyforge.org/files/examples/flat_txt.html[Check ruby prof documentation for a better explanation].
0
 
0
 ===== Graph =====
0
 
0
-Graph output shows how long each method takes to run, which methods call it and which methods it calls. http://ruby-prof.rubyforge.org/files/examples/graph_txt.html[Check ruby prof documentation for a better explaination].
0
+Graph output shows how long each method takes to run, which methods call it and which methods it calls. http://ruby-prof.rubyforge.org/files/examples/graph_txt.html[Check ruby prof documentation for a better explanation].
0
 
0
 ===== Tree =====
0
 
0
@@ -295,7 +295,7 @@ Tree output is profiling information in calltree format for use by http://kcache
0
 
0
 === Tuning Test Runs ===
0
 
0
-By default, each performance test is run +4 times+ in benchmarking model and +1 time+ in profiling. However, test runs can easily be configured.
0
+By default, each performance test is run +4 times+ in benchmarking mode and +1 time+ in profiling. However, test runs can easily be configured.
0
 
0
 CAUTION: That's a lie. But not for long.
0
 
0
@@ -306,7 +306,7 @@ To get the best from Rails performance tests, you need to build a special Ruby b
0
 
0
 The process is fairly straight forward. If you've never compiled a Ruby binary before, follow the following steps to build a ruby binary inside your home directory:
0
 
0
-==== Instllation ====
0
+==== Installation ====
0
 
0
 Compile Ruby and apply this http://rubyforge.org/tracker/download.php/1814/7062/17676/3291/ruby186gc.patch[GC Patch]:
0
 
0
@@ -353,7 +353,7 @@ alias gcrails='~/rubygc/bin/rails'
0
 
0
 Download http://rubyforge.org/projects/rubygems[Rubygems] and install it from source. Rubygem's README file should have necessary installation instructions.
0
 
0
-Additionally, installa the following gems :
0
+Additionally, install the following gems :
0
 
0
   * +rake+
0
   * +rails+
0
@@ -389,7 +389,7 @@ This benchmarks the code enclosed in +Project.benchmark("Creating project") do..
0
 
0
 [source, ruby]
0
 ----------------------------------------------------------------------------
0
-Creating projectem (185.3ms)
0
+Creating project (185.3ms)
0
 ----------------------------------------------------------------------------
0
 
0
 Please refer to http://api.rubyonrails.com/classes/ActiveRecord/Base.html#M001336[API docs] for optional options to +benchmark()+
0
@@ -423,7 +423,7 @@ And in http://api.rubyonrails.com/classes/ActionController/Benchmarking/ClassMet
0
 
0
 == Request Logging ==
0
 
0
-Rails log files containt very useful information about the time taken to serve each request. Here's a typical log file entry:
0
+Rails log files contain very useful information about the time taken to serve each request. Here's a typical log file entry:
0
 
0
 [source, ruby]
0
 ----------------------------------------------------------------------------

Comments