Code

Git.pm: fix documentation of hash_object
authorLea Wiemann <lewiemann@gmail.com>
Sun, 1 Jun 2008 20:26:25 +0000 (22:26 +0200)
committerJunio C Hamano <gitster@pobox.com>
Mon, 2 Jun 2008 05:21:05 +0000 (22:21 -0700)
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>
perl/Git.pm

index d05b633b64ac6440f8c86405beb13df281bde989..e2141b638167d361528e8f2d83a5f4a25238fac4 100644 (file)
@@ -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.