Skip to content

Commit

Permalink
Git.pm: fix documentation of hash_object
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
Lea Wiemann authored and gitster committed Jun 2, 2008
1 parent f1979d6 commit 58c8dd2
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions perl/Git.pm
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 58c8dd2

Please sign in to comment.