[jira] [Commented] (MAPREDUCE-6496) Incorrect javadoc in WritableUtils.java

["Hadoop QA (JIRA)" <ji...@apache.org>]

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

Hadoop QA commented on MAPREDUCE-6496:
--------------------------------------

\\
\\
| (x) *{color:red}-1 overall{color}* |
\\
\\
|| Vote || Subsystem || Runtime || Comment ||
| {color:red}-1{color} | pre-patch |  17m 31s | Pre-patch trunk has 1 extant Findbugs (version 3.0.0) warnings. |
| {color:green}+1{color} | @author |   0m  0s | The patch does not contain any @author tags. |
| {color:red}-1{color} | tests included |   0m  0s | The patch doesn't appear to include any new or modified tests.  Please justify why no new tests are needed for this patch. Also please list what manual steps were performed to verify this patch. |
| {color:green}+1{color} | javac |   7m 55s | There were no new javac warning messages. |
| {color:green}+1{color} | javadoc |  10m 10s | There were no new javadoc warning messages. |
| {color:green}+1{color} | release audit |   0m 25s | The applied patch does not increase the total number of release audit warnings. |
| {color:green}+1{color} | checkstyle |   1m 11s | There were no new checkstyle issues. |
| {color:green}+1{color} | whitespace |   0m  0s | The patch has no lines that end in whitespace. |
| {color:green}+1{color} | install |   1m 29s | mvn install still works. |
| {color:green}+1{color} | eclipse:eclipse |   0m 33s | The patch built with eclipse:eclipse. |
| {color:green}+1{color} | findbugs |   1m 55s | The patch does not introduce any new Findbugs (version 3.0.0) warnings. |
| {color:green}+1{color} | common tests |   6m 54s | Tests passed in hadoop-common. |
| | |  48m  7s | |
\\
\\
|| Subsystem || Report/Notes ||
| Patch URL | http://issues.apache.org/jira/secure/attachment/12764294/MAPREDUCE-6496-00.patch |
| Optional Tests | javadoc javac unit findbugs checkstyle |
| git revision | trunk / 80d33b5 |
| Pre-patch Findbugs warnings | https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/6035/artifact/patchprocess/trunkFindbugsWarningshadoop-common.html |
| hadoop-common test log | https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/6035/artifact/patchprocess/testrun_hadoop-common.txt |
| Test Results | https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/6035/testReport/ |
| Java | 1.7.0_55 |
| uname | Linux asf902.gq1.ygridcore.net 3.13.0-36-lowlatency #63-Ubuntu SMP PREEMPT Wed Sep 3 21:56:12 UTC 2014 x86_64 x86_64 x86_64 GNU/Linux |
| Console output | https://builds.apache.org/job/PreCommit-MAPREDUCE-Build/6035/console |


This message was automatically generated.

> Incorrect javadoc in WritableUtils.java
> ---------------------------------------
>
>                 Key: MAPREDUCE-6496
>                 URL: https://issues.apache.org/jira/browse/MAPREDUCE-6496
>             Project: Hadoop Map/Reduce
>          Issue Type: Bug
>    Affects Versions: 2.7.1
>            Reporter: Martin Petricek
>            Assignee: Jagadesh Kiran N
>            Priority: Minor
>         Attachments: MAPREDUCE-6496-00.patch
>
>
> Documentation for writeVLong in WritableUtils states that "For
>  -112 <= i <= 127, only one byte is used"
> Documentation for writeVInt states that "For -120 <= i <= 127, only one byte is used"
> writeVInt calls internally writeVLong, so the ranges are the same for both functions. 
> After examining the code, I see that the documentation that is at writeVLong is correct.
> Documentation for writeVInt is therefore incorrect and should be fixed.



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