From 37e4e9b313465a6e7278a0724ff65ea8e1840eec Mon Sep 17 00:00:00 2001 From: Jason Noble Date: Sun, 29 Apr 2012 23:18:27 -0600 Subject: Add documentation to command_line.textile explaining how to use additional notes directories --- guides/source/command_line.textile | 13 +++++++++++++ 1 file changed, 13 insertions(+) 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+. + + +$ 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 + + 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. -- cgit v1.2.3