From: Lea Wiemann <lewiemann@gmail.com>
Date: Sun, 1 Jun 2008 20:26:25 +0000 (+0200)
Subject: Git.pm: fix documentation of hash_object
X-Git-Tag: v1.5.6-rc1~17
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=58c8dd217384b8d1a464a55a98c665ed108c6b15;p=git.git

Git.pm: fix documentation of hash_object

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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/perl/Git.pm b/perl/Git.pm
index d05b633b6..e2141b638 100644
--- a/perl/Git.pm
+++ b/perl/Git.pm
@@ -719,9 +719,8 @@ sub ident_person {
 
 =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.