[PATCH] Git.pm: fix documentation of hash_object

From: Lea Wiemann <lewiemann@gmail.com>
Date: Jun 1, 2008, 20:26 UTC
Message-ID: <1212351985-11682-1-git-send-email-LeWiemann@gmail.com>

The documentation of hash_object incorrectly states that it accepts a file handle -- in fact it doesn't, and there is even a TODO comment for this. This fixes the documentation.

Signed-off-by: Lea Wiemann <LeWiemann@gmail.com>
---
This should be implemented eventually, but in the meantime let's just
correct the documentation.

 perl/Git.pm |    5 ++---
 1 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/perl/Git.pm b/perl/Git.pm
index 80f7669..07b92c7 100644
--- a/perl/Git.pm
+++ b/perl/Git.pm
@@ -760,9 +760,8 @@ sub parse_rev {
 
 =item hash_object ( TYPE, FILENAME )
 
-Compute the SHA1 object id of the given C<FILENAME> (or data waiting in
-C<FILEHANDLE>) considering it is of the C<TYPE> object type (C<blob>,
-C<commit>, C<tree>).
+Compute the SHA1 object id of the given C<FILENAME> considering it is
+of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
 
 The method can be called without any instance or on a specified Git repository,
 it makes zero difference.

-- 
1.5.5.GIT