Document App::Rgit::Command::report

[perl/modules/rgit.git] / lib / App / Rgit / Command.pm

diff --git a/lib/App/Rgit/Command.pm b/lib/App/Rgit/Command.pm
index d92eba46d59e7df3b0edf4cff28283fcf8ae64f6..d2d837346f29192ed970a80af41cc60ea60ef950 100644 (file)
--- a/lib/App/Rgit/Command.pm
+++ b/lib/App/Rgit/Command.pm
@@ -80,6 +80,9 @@ sub action {
 
 =head2 C<report $conf, $repo, $status>
 
+Reports that the execution of the command in C<$repo> exited with C<status> to the current command's policy.
+Returns what the policy callback returned, which should be one of the policy codes listed in C<App::Rgit::Utils>.
+
 =cut
 
 sub report {