[HBASE-16970] Clarify misleading Scan.java comment about caching

• Type: Sub-task
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 1.3.0, 1.4.0, 1.2.3, 1.1.7, 2.0.0
• Fix Version/s: 1.3.0, 1.2.5, 1.1.8, 2.0.0
• Labels: documentation patch
• Hadoop Flags: Reviewed
• Assignee: Jim Kleckner
• Reporter: Jim Kleckner
• Created: 29/Oct/16 19:08
• Updated: 09/Nov/17 02:47
• Resolved: 01/Nov/16 18:05

Description

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.