Uploaded image for project: 'Hadoop Common'
  1. Hadoop Common
  2. HADOOP-11857

Fix CommandFormat#commandFormat java doc annotation

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.0.0-alpha1
    • Component/s: None
    • Labels:
    • Hadoop Flags:
      Reviewed

      Description

      The first parameter name does not match with the javadoc.

       
       /**
         * @deprecated use replacement since name is an unused parameter
         * @param name of command, but never used
         * @param min see replacement
         * @param max see replacement
         * @param possibleOpt see replacement
         * @see #CommandFormat(int, int, String...)
         */
        @Deprecated
        public CommandFormat(String n, int min, int max, String ... possibleOpt) {
          this(min, max, possibleOpt);
        }
      

        Issue Links

          Activity

          Hide
          andreina J.Andreina added a comment -

          Thanks Xiaoyu Yao for raising this issue .Can i assign this issue to me,if you have not started working on this.

          Show
          andreina J.Andreina added a comment - Thanks Xiaoyu Yao for raising this issue .Can i assign this issue to me,if you have not started working on this.
          Hide
          xyao Xiaoyu Yao added a comment -

          J.Andreina, I assigned the issue to you. Feel free to post your patch for fix.

          Show
          xyao Xiaoyu Yao added a comment - J.Andreina , I assigned the issue to you. Feel free to post your patch for fix.
          Hide
          andreina J.Andreina added a comment -

          Attached an initial patch
          Please review .

          Show
          andreina J.Andreina added a comment - Attached an initial patch Please review .
          Hide
          hadoopqa Hadoop QA added a comment -



          -1 overall



          Vote Subsystem Runtime Comment
          0 pre-patch 14m 34s Pre-patch trunk compilation is healthy.
          +1 @author 0m 0s The patch does not contain any @author tags.
          -1 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.
          +1 whitespace 0m 0s The patch has no lines that end in whitespace.
          +1 javac 7m 31s There were no new javac warning messages.
          +1 javadoc 9m 37s There were no new javadoc warning messages.
          +1 release audit 0m 22s The applied patch does not increase the total number of release audit warnings.
          +1 checkstyle 3m 59s There were no new checkstyle issues.
          +1 install 1m 36s mvn install still works.
          +1 eclipse:eclipse 0m 33s The patch built with eclipse:eclipse.
          +1 findbugs 1m 39s The patch does not introduce any new Findbugs (version 2.0.3) warnings.
          +1 common tests 22m 15s Tests passed in hadoop-common.
              62m 9s  



          Subsystem Report/Notes
          Patch URL http://issues.apache.org/jira/secure/attachment/12728226/HADOOP-11857.1.patch
          Optional Tests javadoc javac unit findbugs checkstyle
          git revision trunk / 22b70e7
          hadoop-common test log https://builds.apache.org/job/PreCommit-HADOOP-Build/6184/artifact/patchprocess/testrun_hadoop-common.txt
          Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/6184/testReport/
          Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/6184/console

          This message was automatically generated.

          Show
          hadoopqa Hadoop QA added a comment - -1 overall Vote Subsystem Runtime Comment 0 pre-patch 14m 34s Pre-patch trunk compilation is healthy. +1 @author 0m 0s The patch does not contain any @author tags. -1 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. +1 whitespace 0m 0s The patch has no lines that end in whitespace. +1 javac 7m 31s There were no new javac warning messages. +1 javadoc 9m 37s There were no new javadoc warning messages. +1 release audit 0m 22s The applied patch does not increase the total number of release audit warnings. +1 checkstyle 3m 59s There were no new checkstyle issues. +1 install 1m 36s mvn install still works. +1 eclipse:eclipse 0m 33s The patch built with eclipse:eclipse. +1 findbugs 1m 39s The patch does not introduce any new Findbugs (version 2.0.3) warnings. +1 common tests 22m 15s Tests passed in hadoop-common.     62m 9s   Subsystem Report/Notes Patch URL http://issues.apache.org/jira/secure/attachment/12728226/HADOOP-11857.1.patch Optional Tests javadoc javac unit findbugs checkstyle git revision trunk / 22b70e7 hadoop-common test log https://builds.apache.org/job/PreCommit-HADOOP-Build/6184/artifact/patchprocess/testrun_hadoop-common.txt Test Results https://builds.apache.org/job/PreCommit-HADOOP-Build/6184/testReport/ Console output https://builds.apache.org/job/PreCommit-HADOOP-Build/6184/console This message was automatically generated.
          Hide
          andreina J.Andreina added a comment -

          This issue is for javadoc updation . Does not need Testcase.
          Please review.

          Show
          andreina J.Andreina added a comment - This issue is for javadoc updation . Does not need Testcase. Please review.
          Hide
          jghoman Jakob Homan added a comment -

          +1. I've committed this. Resolving. Thanks, J.Andreina!

          Show
          jghoman Jakob Homan added a comment - +1. I've committed this. Resolving. Thanks, J.Andreina!
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-trunk-Commit #7682 (See https://builds.apache.org/job/Hadoop-trunk-Commit/7682/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          • hadoop-common-project/hadoop-common/CHANGES.txt
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-trunk-Commit #7682 (See https://builds.apache.org/job/Hadoop-trunk-Commit/7682/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java hadoop-common-project/hadoop-common/CHANGES.txt
          Hide
          andreina J.Andreina added a comment -

          Thanks Jakob Homan for the commit.

          Show
          andreina J.Andreina added a comment - Thanks Jakob Homan for the commit.
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-Hdfs-trunk #2108 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/2108/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          • hadoop-common-project/hadoop-common/CHANGES.txt
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk #2108 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk/2108/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java hadoop-common-project/hadoop-common/CHANGES.txt
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #167 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/167/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/CHANGES.txt
          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Hdfs-trunk-Java8 #167 (See https://builds.apache.org/job/Hadoop-Hdfs-trunk-Java8/167/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-Yarn-trunk #910 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/910/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/CHANGES.txt
          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Yarn-trunk #910 (See https://builds.apache.org/job/Hadoop-Yarn-trunk/910/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-Yarn-trunk-Java8 #176 (See https://builds.apache.org/job/Hadoop-Yarn-trunk-Java8/176/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/CHANGES.txt
          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Yarn-trunk-Java8 #176 (See https://builds.apache.org/job/Hadoop-Yarn-trunk-Java8/176/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-Mapreduce-trunk-Java8 #177 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Java8/177/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          • hadoop-common-project/hadoop-common/CHANGES.txt
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Mapreduce-trunk-Java8 #177 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk-Java8/177/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java hadoop-common-project/hadoop-common/CHANGES.txt
          Hide
          hudson Hudson added a comment -

          FAILURE: Integrated in Hadoop-Mapreduce-trunk #2126 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/2126/)
          HADOOP-11857. Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b)

          • hadoop-common-project/hadoop-common/CHANGES.txt
          • hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java
          Show
          hudson Hudson added a comment - FAILURE: Integrated in Hadoop-Mapreduce-trunk #2126 (See https://builds.apache.org/job/Hadoop-Mapreduce-trunk/2126/ ) HADOOP-11857 . Fix CommandFormat#commandFormat java doc annotation. Contributed by J.Andreina. (jghoman: rev 1a2459bd4be54e64eec0eebffd941989476c2a5b) hadoop-common-project/hadoop-common/CHANGES.txt hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/fs/shell/CommandFormat.java

            People

            • Assignee:
              andreina J.Andreina
              Reporter:
              xyao Xiaoyu Yao
            • Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development