hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Yu Li (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-16970) Clarify misleading Scan.java comment about caching
Date Tue, 01 Nov 2016 09:26:58 GMT

    [ https://issues.apache.org/jira/browse/HBASE-16970?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15624907#comment-15624907
] 

Yu Li commented on HBASE-16970:
-------------------------------

Aye, sounds good, let me commit with this comment. Thank god I still haven't commit this (Smile).

To be more specified, will commit with below change:
{code}
-  /*
-   * -1 means no caching
+  /**
+   * -1 means no caching specified and the value of {@link HConstants#HBASE_CLIENT_SCANNER_CACHING}
+   * (default to {@link HConstants#DEFAULT_HBASE_CLIENT_SCANNER_CACHING}) will be used
    */
   private int caching = -1;
{code}

> Clarify misleading Scan.java comment about caching
> --------------------------------------------------
>
>                 Key: HBASE-16970
>                 URL: https://issues.apache.org/jira/browse/HBASE-16970
>             Project: HBase
>          Issue Type: Bug
>            Reporter: Jim Kleckner
>            Priority: Trivial
>              Labels: documentation, patch
>         Attachments: HBASE-16970.patch
>
>
> The Scan class has an integer field, caching, that defaults to -1.  The meaning of -1
is that the option was not overriden (aka not set) and therefore that the default configuration
should be used.
> This trivial patch corrects the comment of that field to reflect this meaning rather
than misleading the reader to believe that caching is disabled.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message