diff options
| author | Vijay Dev <vijaydev.cse@gmail.com> | 2011-06-15 23:26:19 +0530 |
|---|---|---|
| committer | Vijay Dev <vijaydev.cse@gmail.com> | 2011-06-15 23:26:19 +0530 |
| commit | 406d61ee8c0311f742ac74b9a15845cc3cd214d3 (patch) | |
| tree | 2aec31ab9a0567e157a7184775c27623efa5f9a8 /railties | |
| parent | 3e441596509bbb5eb485c60efe78a629c028562e (diff) | |
| download | rails-406d61ee8c0311f742ac74b9a15845cc3cd214d3.tar.gz rails-406d61ee8c0311f742ac74b9a15845cc3cd214d3.tar.bz2 rails-406d61ee8c0311f742ac74b9a15845cc3cd214d3.zip | |
add details on how to use specific annotations in rake:notes
Diffstat (limited to 'railties')
| -rw-r--r-- | railties/guides/source/command_line.textile | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/railties/guides/source/command_line.textile b/railties/guides/source/command_line.textile index c71baa76d1..03ff3097da 100644 --- a/railties/guides/source/command_line.textile +++ b/railties/guides/source/command_line.textile @@ -402,7 +402,7 @@ If you want to strip out or rebuild any of the Rails documentation (including th h4. +notes+ -+rake notes+ will search through your code for comments beginning with FIXME, OPTIMIZE or TODO. This checks only for files with extension +.builder+, +.rb+, +.rxml+, +.rhtml+ and +.erb+. ++rake notes+ will search through your code for comments beginning with FIXME, OPTIMIZE or TODO. The search is only done in files with extension +.builder+, +.rb+, +.rxml+, +.rhtml+ and +.erb+ for both default and custom annotations. <shell> $ rake notes @@ -416,7 +416,19 @@ app/model/school.rb: * [ 17] [FIXME] </shell> -You can also use custom annotations in your code and list them using +rake notes:custom+ and specify the annotation using an environment variable +ANNOTATION+. +If you are looking for a specific annotation, say FIXME, you can use +rake notes:fixme+. Note that you have to lower case the annotation's name. + +<shell> +$ rake notes:fixme +(in /home/foobar/commandsapp) +app/controllers/admin/users_controller.rb: + * [132] high priority for next deploy + +app/model/school.rb: + * [ 17] +</shell> + +You can also use custom annotations in your code and list them using +rake notes:custom+ by specifying the annotation using an environment variable +ANNOTATION+. <shell> $ rake notes:custom ANNOTATION=BUG @@ -425,6 +437,8 @@ app/model/post.rb: * [ 23] Have to fix this one before pushing! </shell> +NOTE. When using specific annotations and custom annotations, the annotation name (FIXME, BUG etc) is not displayed in the output lines. + h4. +routes+ +rake routes+ will list all of your defined routes, which is useful for tracking down routing problems in your app, or giving you a good overview of the URLs in an app you're trying to get familiar with. |