[
https://issues.apache.org/jira/browse/HDFS-10678?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15411050#comment-15411050
]
Konstantin Shvachko commented on HDFS-10678:
--------------------------------------------
Looks very good, thanks for documenting. Couple of comments:
# "Hadoop common set of configuration options" should rather say something like
"Hadoop command-line Generic Options".
# In the Report section it would be good to post an example of a real output of
the benchmark.
# Should we remove JavaDoc description? Can still be useful for developers. At
least it would be good to add a link in JavaDoc to the site with full
description.
> Documenting NNThroughputBenchmark tool
> --------------------------------------
>
> Key: HDFS-10678
> URL: https://issues.apache.org/jira/browse/HDFS-10678
> Project: Hadoop HDFS
> Issue Type: Sub-task
> Components: benchmarks, test
> Reporter: Mingliang Liu
> Assignee: Mingliang Liu
> Labels: documentation
> Attachments: HDFS-10678.000.patch, HDFS-10678.001.patch,
> HDFS-10678.002.patch
>
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org
