Return-Path: X-Original-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Delivered-To: apmail-hadoop-common-issues-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1978B9B10 for ; Thu, 5 Apr 2012 00:01:46 +0000 (UTC) Received: (qmail 37479 invoked by uid 500); 5 Apr 2012 00:01:45 -0000 Delivered-To: apmail-hadoop-common-issues-archive@hadoop.apache.org Received: (qmail 37449 invoked by uid 500); 5 Apr 2012 00:01:45 -0000 Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: common-issues@hadoop.apache.org Delivered-To: mailing list common-issues@hadoop.apache.org Received: (qmail 37441 invoked by uid 99); 5 Apr 2012 00:01:45 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Apr 2012 00:01:45 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED,T_RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.116] (HELO hel.zones.apache.org) (140.211.11.116) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Apr 2012 00:01:43 +0000 Received: from hel.zones.apache.org (hel.zones.apache.org [140.211.11.116]) by hel.zones.apache.org (Postfix) with ESMTP id 70241359214 for ; Thu, 5 Apr 2012 00:01:21 +0000 (UTC) Date: Thu, 5 Apr 2012 00:01:21 +0000 (UTC) From: "Hudson (Commented) (JIRA)" To: common-issues@hadoop.apache.org Message-ID: <1418294162.14987.1333584081591.JavaMail.tomcat@hel.zones.apache.org> In-Reply-To: <848343800.8117.1333483103905.JavaMail.tomcat@hel.zones.apache.org> Subject: [jira] [Commented] (HADOOP-8244) Improve comments on ByteBufferReadable.read MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/HADOOP-8244?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13246867#comment-13246867 ] Hudson commented on HADOOP-8244: -------------------------------- Integrated in Hadoop-Hdfs-trunk-Commit #2074 (See [https://builds.apache.org/job/Hadoop-Hdfs-trunk-Commit/2074/]) HADOOP-8244. Improve comments on ByteBufferReadable.read. Contributed by Henry Robinson. (Revision 1309625) Result = SUCCESS atm : http://svn.apache.org/viewcvs.cgi/?root=Apache-SVN&view=rev&rev=1309625 Files : * /hadoop/common/trunk/hadoop-common-project/hadoop-common/CHANGES.txt * /hadoop/common/trunk/hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/ByteBufferReadable.java > Improve comments on ByteBufferReadable.read > ------------------------------------------- > > Key: HADOOP-8244 > URL: https://issues.apache.org/jira/browse/HADOOP-8244 > Project: Hadoop Common > Issue Type: Improvement > Reporter: Henry Robinson > Assignee: Henry Robinson > Fix For: 0.24.0 > > Attachments: HADOOP-8244.0.patch, HADOOP-8244.1.patch > > > There are a couple of ways in which the comment on ByteBufferReadable.read can be improved. Since this is a public-facing API with potentially many implementations, it's worth taking the time to get it right. > * We should describe what can become of the byte buffer state in the case of an exception (is the limit changed? where's the position?). For the DFSInputStream implementation, position and limit are unchanged if there is an error, but I don't think that's the right think to mandate for all implementations. > * We should mention explicitly that 0-byte reads are legitimate - this is particularly important in light of HDFS-3110 which detects support for direct reads by issuing a 0-byte read from libhdfs. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa For more information on JIRA, see: http://www.atlassian.com/software/jira