From: Tomas Doran <bobtfish@bobtfish.net>
Date: Thu, 16 Feb 2012 21:58:37 +0000 (+0000)
Subject: Doc new function
X-Git-Tag: 5.90010~1
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=40e6e221c7a74a564b2a393070273c5864094f24

Doc new function
---

diff --git a/lib/Catalyst/Utils.pm b/lib/Catalyst/Utils.pm
index 020ebc9..fd7b376 100644
--- a/lib/Catalyst/Utils.pm
+++ b/lib/Catalyst/Utils.pm
@@ -205,6 +205,17 @@ sub home {
     return 0;
 }
 
+=head2 find_home_unloaded_in_checkout ($path)
+
+Tries to determine if C<$path> (or cwd if not supplied)
+looks like a checkout. Any leading lib or blib components
+will be removed, then the directory produced will be checked
+for the existance of a C<< dist_indicator_file_list() >>.
+
+If one is found, the directory will be returned, otherwise false.
+
+=cut
+
 sub find_home_unloaded_in_checkout {
     my ($path) = @_;
     $path ||= cwd() if !defined $path || !length $path;