aboutsummaryrefslogtreecommitdiffstats
path: root/guides/source/command_line.textile
diff options
context:
space:
mode:
authorJason Noble <github+jasonn@jasonnoble.org>2012-04-29 23:18:27 -0600
committerJason Noble <github+jasonn@jasonnoble.org>2012-04-30 07:48:36 -0600
commit37e4e9b313465a6e7278a0724ff65ea8e1840eec (patch)
tree889fb326a810c7f603ba614d24677e06fc3eee5a /guides/source/command_line.textile
parente053b415e7874b56c5ac788644c68e264a1cef33 (diff)
downloadrails-37e4e9b313465a6e7278a0724ff65ea8e1840eec.tar.gz
rails-37e4e9b313465a6e7278a0724ff65ea8e1840eec.tar.bz2
rails-37e4e9b313465a6e7278a0724ff65ea8e1840eec.zip
Add documentation to command_line.textile explaining how to use additional notes directories
Diffstat (limited to 'guides/source/command_line.textile')
-rw-r--r--guides/source/command_line.textile13
1 files changed, 13 insertions, 0 deletions
diff --git a/guides/source/command_line.textile b/guides/source/command_line.textile
index 858ce47db1..95a01710b5 100644
--- a/guides/source/command_line.textile
+++ b/guides/source/command_line.textile
@@ -446,6 +446,19 @@ app/model/post.rb:
NOTE. When using specific annotations and custom annotations, the annotation name (FIXME, BUG etc) is not displayed in the output lines.
+Be default, rake notes will look in the app, config, lib, script and test directories for notes. If you would like to search additional directories,
+simply provide the directories as a comma seperated list in an environment variable +SOURCE_ANNOTATION_DIRECTORIES+.
+
+<shell>
+$ export SOURCE_ANNOTATION_DIRECTORIES='rspec,vendor'
+$ rake notes
+(in /home/foobar/commandsapp)
+app/model/user.rb:
+ * [ 35] [FIXME] User should have a subscription at this point
+rspec/model/user_spec.rb:
+ * [122] [TODO] Verify the user that has a subscription works
+</shell>
+
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.