[HBASE-21415] Admin#snapshot method documentation is misleading.

• Type: Improvement
• Status: Resolved
• Priority: Trivial
• Resolution: Fixed
• Fix Version/s: 3.0.0-alpha-1
• Component/s: documentation
• Hadoop Flags: Reviewed
• Assignee: Philippe Laflamme
• Reporter: Philippe Laflamme
• Created: 31/Oct/18 21:45
• Updated: 04/Jun/19 23:20
• Resolved: 04/Jun/19 16:23

Description

The documentation for the Admin#snapshot function is misleading in regards to snapshot concurrency.

It currently states the following: 

Only a single snapshot should be taken at a time for an instance of HBase, or results may be undefined (you can tell multiple HBase clusters to snapshot at the same time, but only one at a time for a single cluster).

This seems to indicate that it's dangerous to run snapshots concurrently when in fact the HBase master will simply run them sequentially (as per this Slack thread https://apache-hbase.slack.com/archives/C13K8NVAM/p1540994948005900)

The suggested fix is to simply remove this entire sentence.