[jira] [Commented] (MAPREDUCE-4285) Code sample in Tool javadocs is broken

["Gergely Novák (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MAPREDUCE-4285?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15278273#comment-15278273 ] 

Gergely Novák commented on MAPREDUCE-4285:
------------------------------------------

I can't see how to create a new unit test for this. 

Manual steps to verify the patch:
* Generate javadoc with {{mvn javadoc:javadoc}}
* Check hadoop-common-project/hadoop-common/target/site/api/org/apache/hadoop/util/Tool.html
* Check that the code in the comment works
** I created a sample MapReduce project with this code copy-pasted
** The MyMapper and MyReducer classes were simple subclasses of Mapper and Reducer
** Compiled and ran the program - it worked as expected

> Code sample in Tool javadocs is broken
> --------------------------------------
>
>                 Key: MAPREDUCE-4285
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-4285
>             Project: Hadoop Map/Reduce
>          Issue Type: Bug
>          Components: mrv1
>    Affects Versions: 1.0.3
>            Reporter: Steve Loughran
>            Assignee: Gergely Novák
>            Priority: Minor
>         Attachments: MAPREDUCE-4285.001.patch
>
>
> The javadocs in {{org.apache.hadoop.util.Tool}} contain an example to use the tool runner to invoke a tool.
> If you copy and paste the example into a java file it doesn't even compile
> # {{job.setInputPath()}} isn't there
> # {{job.setOutputPath()}} isn't there
> # {{job.waitForCompletion()}} isn't invoked
> # the {{Tool.run()}} implementation doesn't contain a return statement.
> The processed javadocs are online: [http://hadoop.apache.org/common/docs/r1.0.3/api/org/apache/hadoop/util/Tool.html]



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: mapreduce-issues-unsubscribe@hadoop.apache.org
For additional commands, e-mail: mapreduce-issues-help@hadoop.apache.org