[HDFS-10678] Documenting NNThroughputBenchmark tool

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.8.0, 3.0.0-alpha1
• Component/s: benchmarks, test
• Labels: documentation
• Target Version/s: 2.8.0
• Hadoop Flags: Reviewed
• Assignee: Mingliang Liu
• Reporter: Mingliang Liu
• Created: 22/Jul/16 02:26
• Updated: 30/Aug/16 01:14
• Resolved: 16/Aug/16 04:03

Description

The best (only) documentation for the NNThroughputBenchmark currently exists as a JavaDoc on the NNThroughputBenchmark class. This is less than useful, especially since we no longer generate javadocs for HDFS as part of the build process. I suggest we extract it into a separate markdown doc, or merge it with other benchmarking materials (if any?) about HDFS.