Permalink
Browse files

README.vim, Rakefile, Rantfile: format README.vim with RDoc.

darcs-hash:20060611081929-0786a-e84ab256c2c09f5ed7e4d32ee3bfa8cdf1e5bf2d.gz
  • Loading branch information...
1 parent 28c6413 commit e28bed06d544132ad49c800603bcaceba482aac5 @mfp mfp committed Jun 11, 2006
Showing with 22 additions and 19 deletions.
  1. +19 −18 README.vim
  2. +1 −0 Rakefile
  3. +2 −1 Rantfile
View
@@ -1,40 +1,39 @@
-rcov.vim allows you to run test unit tests from vim and enter quickfix mode in
+<tt>rcov.vim</tt> allows you to run unit tests from vim and enter quickfix mode in
order to jump to uncovered code introduced since the last run.
-Installation
-============
-Copy rcov.vim to the appropriate "compiler" directory (typically
-$HOME/.vim/compiler).
+== Installation
+Copy <tt>rcov.vim</tt> to the appropriate "compiler" directory (typically
+<tt>$HOME/.vim/compiler</tt>).
-Usage
-=====
+== Usage
-Setting the reference point
----------------------------
-rcov's --text-coverage-diff mode compares the current coverage status against
-a previously stored one. It therefore needs that information to be saved
+=== Setting the reference point
+
++rcov+'s <tt>--text-coverage-diff</tt> mode compares the current coverage status against
+the saved one. It therefore needs that information to be recorded
before you write new code (typically right after you perform a commit) in
order to have something to compare against.
-You can save the current status with the --save option.
-If you're running rcov from Rake, you can do something like
+You can save the current status with the <tt>--save</tt> option.
+If you're running +rcov+ from Rake, you can do something like
rake rcov_units RCOVOPTS="-T --save --rails"
in order to take the current status as the reference point.
-Comparing with a recorded coverage status
------------------------------------------
+=== Finding new uncovered code
+
Type the following in command mode while editing your program:
:compiler rcov
-rcov.vim assumes rcov can be invoked with a rake task (see README.rake for
+rcov.vim assumes +rcov+ can be invoked with a rake task (see
+README.rake[link:files/README_rake.html] for
information on how to create it).
-You can then execute rcov and enter quickfix mode by typing
+You can then execute +rcov+ and enter quickfix mode by typing
:make <taskname>
-where taskname is the rcov task you want to use; if you didn't override the
+where taskname is the +rcov+ task you want to use; if you didn't override the
default name in the Rakefile, just
:make rcov
@@ -44,3 +43,5 @@ will do.
vim will then enter quickfix mode, allowing you to jump to the areas that were
not covered since the last time you saved the coverage data.
+--------
+# vim: ft=text :
View
@@ -71,6 +71,7 @@ Rake::RDocTask.new("rdoc") { |rdoc|
rdoc.rdoc_files.include('README.API')
rdoc.rdoc_files.include('README.rake')
rdoc.rdoc_files.include('README.rant')
+ rdoc.rdoc_files.include('README.vim')
rdoc.rdoc_files.include('lib/**/*.rb')
}
View
@@ -64,7 +64,8 @@ desc "Generate documentation."
gen RubyDoc, :rdoc do |g|
g.verbose = true
g.dir = "doc"
- g.files = sys["README.API", "README.rake", "README.rant", "lib/**/*.rb"]
+ g.files = sys["README.API", "README.rake", "README.rant", "README.vim",
+ "lib/**/*.rb"]
g.opts = %w(--line-numbers --inline-source --title rcov --main README.API)
end

0 comments on commit e28bed0

Please sign in to comment.