git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH] Git.pm: fix documentation of hash_object
@ 2008-06-01 20:26 Lea Wiemann
  0 siblings, 0 replies; only message in thread
From: Lea Wiemann @ 2008-06-01 20:26 UTC (permalink / raw)
  To: git; +Cc: Lea Wiemann

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

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2008-06-01 20:27 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-06-01 20:26 [PATCH] Git.pm: fix documentation of hash_object Lea Wiemann

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).