[
https://issues.apache.org/jira/browse/HDFS-10678?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Mingliang Liu updated HDFS-10678:
---------------------------------
Attachment: HDFS-10678.003.patch
Thanks for the review and suggestions, [~shv]. The v3 patch is to address your
comments.
Specially, all javadoc descriptions are not removed. Just the usage part is
deleted from the javadoc as 1) it was mostly incomplete for years; 2) it may be
a burden to maintain two copies of usage doc (in javadoc and dedicated
documentation). Considering these two reasons, in the v3 patch I added a link
in JavaDoc to the site with full description as you suggested.
> 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, HDFS-10678.003.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: [email protected]
For additional commands, e-mail: [email protected]
