HBASE-22586 Javadoc Warnings related to @param tag #322

murtazahassan123 · 2019-06-18T18:28:45Z

Fixed javadoc warnings related to @param tag.

HorizonNet · 2019-06-22T19:07:31Z

@SyedMurtazaHassan Could you please resolve the merge conflict?

jatsakthi · 2019-06-27T22:36:34Z

@SyedMurtazaHassan any updates on this?

murtazahassan123 · 2019-06-28T16:00:01Z

@jatsakthi Resolved the merge conflict. Kindly review.

Apache-HBase · 2019-06-28T19:29:27Z

🎊 +1 overall

Vote	Subsystem	Runtime	Comment
0	reexec	29	Docker mode activated.
		_ Prechecks _
+1	hbaseanti	0	Patch does not have any anti-patterns.
+1	@author	0	The patch does not contain any @author tags.
+1	test4tests	0	The patch appears to include 7 new or modified test files.
		_ master Compile Tests _
0	mvndep	11	Maven dependency ordering for branch
+1	mvninstall	230	master passed
+1	compile	107	master passed
+1	checkstyle	110	master passed
+1	shadedjars	252	branch has no errors when building our shaded downstream artifacts.
+1	findbugs	305	master passed
+1	javadoc	80	master passed
		_ Patch Compile Tests _
0	mvndep	14	Maven dependency ordering for patch
+1	mvninstall	237	the patch passed
+1	compile	111	the patch passed
+1	javac	111	the patch passed
+1	checkstyle	23	The patch passed checkstyle in hbase-common
+1	checkstyle	10	The patch passed checkstyle in hbase-hadoop2-compat
+1	checkstyle	64	hbase-server: The patch generated 0 new + 87 unchanged - 4 fixed = 87 total (was 91)
+1	checkstyle	16	The patch passed checkstyle in hbase-mapreduce
+1	whitespace	0	The patch has no whitespace issues.
+1	shadedjars	262	patch has no errors when building our shaded downstream artifacts.
+1	hadoopcheck	717	Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1	findbugs	343	the patch passed
+1	javadoc	87	the patch passed
		_ Other Tests _
+1	unit	189	hbase-common in the patch passed.
+1	unit	34	hbase-hadoop2-compat in the patch passed.
+1	unit	7950	hbase-server in the patch passed.
+1	unit	1063	hbase-mapreduce in the patch passed.
+1	asflicense	78	The patch does not generate ASF License warnings.
		12681

Subsystem	Report/Notes
Docker	Client=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/1/artifact/out/Dockerfile
GITHUB PR	#322
Optional Tests	dupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
uname	Linux f4a38da3d394 4.4.0-138-generic #164-Ubuntu SMP Tue Oct 2 17:16:02 UTC 2018 x86_64 GNU/Linux
Build tool	maven
Personality	/testptch/patchprocess/precommit/personality/provided.sh
git revision	master / `0c8dc5d`
maven	version: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java	1.8.0_181
findbugs	v3.1.11
Test Results	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/1/testReport/
Max. process+thread count	5462 (vs. ulimit of 10000)
modules	C: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console output	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/1/console
Powered by	Apache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

HorizonNet

Left a few comments for improvements.

hbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java

hbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java

hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java

hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java

hbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java

hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java

hbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java

hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java

… according to Jan's comments

murtazahassan123 · 2019-07-01T09:36:27Z

improvements

@HorizonNet Thank you. Addressed your comments. Kindly have a look.

Apache-HBase · 2019-07-01T15:43:38Z

💔 -1 overall

Vote	Subsystem	Runtime	Comment
0	reexec	165	Docker mode activated.
		_ Prechecks _
+1	hbaseanti	0	Patch does not have any anti-patterns.
+1	@author	0	The patch does not contain any @author tags.
+1	test4tests	0	The patch appears to include 7 new or modified test files.
		_ master Compile Tests _
0	mvndep	20	Maven dependency ordering for branch
+1	mvninstall	249	master passed
+1	compile	117	master passed
+1	checkstyle	126	master passed
+1	shadedjars	269	branch has no errors when building our shaded downstream artifacts.
+1	findbugs	315	master passed
+1	javadoc	84	master passed
		_ Patch Compile Tests _
0	mvndep	16	Maven dependency ordering for patch
+1	mvninstall	239	the patch passed
+1	compile	117	the patch passed
+1	javac	117	the patch passed
+1	checkstyle	25	The patch passed checkstyle in hbase-common
+1	checkstyle	12	The patch passed checkstyle in hbase-hadoop2-compat
+1	checkstyle	69	hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1	checkstyle	16	The patch passed checkstyle in hbase-mapreduce
+1	whitespace	0	The patch has no whitespace issues.
+1	shadedjars	267	patch has no errors when building our shaded downstream artifacts.
+1	hadoopcheck	704	Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1	findbugs	349	the patch passed
+1	javadoc	83	the patch passed
		_ Other Tests _
+1	unit	181	hbase-common in the patch passed.
+1	unit	35	hbase-hadoop2-compat in the patch passed.
-1	unit	16627	hbase-server in the patch failed.
-1	unit	1539	hbase-mapreduce in the patch failed.
+1	asflicense	96	The patch does not generate ASF License warnings.
		22062

Reason	Tests
Failed junit tests	hadoop.hbase.master.procedure.TestSCPWithReplicas
	hadoop.hbase.client.TestSnapshotTemporaryDirectory
	hadoop.hbase.client.TestSnapshotDFSTemporaryDirectory
	hadoop.hbase.client.TestAsyncSnapshotAdminApi
	hadoop.hbase.snapshot.TestExportSnapshotNoCluster

Subsystem	Report/Notes
Docker	Client=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/artifact/out/Dockerfile
GITHUB PR	#322
Optional Tests	dupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
uname	Linux 458c23988b59 4.4.0-138-generic #164-Ubuntu SMP Tue Oct 2 17:16:02 UTC 2018 x86_64 GNU/Linux
Build tool	maven
Personality	/testptch/patchprocess/precommit/personality/provided.sh
git revision	master / `0c8dc5d`
maven	version: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java	1.8.0_181
findbugs	v3.1.11
unit	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/artifact/out/patch-unit-hbase-server.txt
unit	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/artifact/out/patch-unit-hbase-mapreduce.txt
Test Results	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/testReport/
Max. process+thread count	5305 (vs. ulimit of 10000)
modules	C: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console output	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/console
Powered by	Apache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

saintstack · 2019-07-01T21:42:09Z

Re-running build.

Apache-HBase · 2019-07-02T04:18:37Z

💔 -1 overall

Vote	Subsystem	Runtime	Comment
0	reexec	51	Docker mode activated.
		_ Prechecks _
+1	hbaseanti	0	Patch does not have any anti-patterns.
+1	@author	0	The patch does not contain any @author tags.
+1	test4tests	0	The patch appears to include 7 new or modified test files.
		_ master Compile Tests _
0	mvndep	18	Maven dependency ordering for branch
+1	mvninstall	274	master passed
+1	compile	121	master passed
+1	checkstyle	128	master passed
+1	shadedjars	276	branch has no errors when building our shaded downstream artifacts.
+1	findbugs	320	master passed
+1	javadoc	86	master passed
		_ Patch Compile Tests _
0	mvndep	15	Maven dependency ordering for patch
+1	mvninstall	240	the patch passed
+1	compile	119	the patch passed
+1	javac	119	the patch passed
+1	checkstyle	24	The patch passed checkstyle in hbase-common
+1	checkstyle	12	The patch passed checkstyle in hbase-hadoop2-compat
+1	checkstyle	72	hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1	checkstyle	17	The patch passed checkstyle in hbase-mapreduce
+1	whitespace	0	The patch has no whitespace issues.
+1	shadedjars	264	patch has no errors when building our shaded downstream artifacts.
+1	hadoopcheck	742	Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1	findbugs	341	the patch passed
+1	javadoc	84	the patch passed
		_ Other Tests _
+1	unit	174	hbase-common in the patch passed.
+1	unit	43	hbase-hadoop2-compat in the patch passed.
-1	unit	16057	hbase-server in the patch failed.
-1	unit	1587	hbase-mapreduce in the patch failed.
+1	asflicense	133	The patch does not generate ASF License warnings.
		21568

Reason	Tests
Failed junit tests	hadoop.hbase.client.TestFromClientSideWithCoprocessor
	hadoop.hbase.master.TestMasterShutdown
	hadoop.hbase.snapshot.TestExportSnapshotNoCluster

Subsystem	Report/Notes
Docker	Client=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/artifact/out/Dockerfile
GITHUB PR	#322
Optional Tests	dupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
uname	Linux a6a0f5a14afd 4.4.0-138-generic #164-Ubuntu SMP Tue Oct 2 17:16:02 UTC 2018 x86_64 GNU/Linux
Build tool	maven
Personality	/testptch/patchprocess/precommit/personality/provided.sh
git revision	master / `52eb893`
maven	version: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java	1.8.0_181
findbugs	v3.1.11
unit	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/artifact/out/patch-unit-hbase-server.txt
unit	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/artifact/out/patch-unit-hbase-mapreduce.txt
Test Results	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/testReport/
Max. process+thread count	5447 (vs. ulimit of 10000)
modules	C: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console output	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/console
Powered by	Apache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

jatsakthi

The addition of class links in the params is not consistent in few places. For e.g. CellComparator's link is added in compareWithoutRow() but not in compare(). Can we fix all such cases?

murtazahassan123 · 2019-07-04T09:07:40Z

@jatsakthi
Should i fix all such cases as a part of this ticket?
Because in this ticket i added javadoc for compareWithoutRow() and didnt touch compare() so i didnt know CellComparator's link is not there.

hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java

hbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java

HorizonNet · 2019-07-04T09:50:22Z

hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java

-   * @throws IOException
+   * @param zk single zookeeper watcher
+   * @param expectedAddress the expected address of the master
+   * @throws KeeperException unexpected zookeeper exception


"ZooKeeper"

HorizonNet · 2019-07-04T09:52:11Z

@SyedMurtazaHassan My suggestion is, if you need to touch the class due to param changes, you can do it in this PR.

murtazahassan123 · 2019-07-04T10:32:19Z

@HorizonNet
Thanks for valuable comments. I will address them and make the fixes accordingly..

murtazahassan123 · 2019-07-08T12:59:26Z

@jatsakthi @HorizonNet Adressed the comments. Kindly have a look when you have time.
Thanks.

Apache-HBase · 2019-07-08T18:39:24Z

💔 -1 overall

Vote	Subsystem	Runtime	Comment
0	reexec	179	Docker mode activated.
		_ Prechecks _
+1	hbaseanti	0	Patch does not have any anti-patterns.
+1	@author	0	The patch does not contain any @author tags.
+1	test4tests	0	The patch appears to include 7 new or modified test files.
		_ master Compile Tests _
0	mvndep	24	Maven dependency ordering for branch
+1	mvninstall	260	master passed
+1	compile	114	master passed
+1	checkstyle	117	master passed
+1	shadedjars	271	branch has no errors when building our shaded downstream artifacts.
+1	findbugs	320	master passed
+1	javadoc	82	master passed
		_ Patch Compile Tests _
0	mvndep	14	Maven dependency ordering for patch
+1	mvninstall	241	the patch passed
+1	compile	113	the patch passed
+1	javac	113	the patch passed
+1	checkstyle	21	hbase-common: The patch generated 0 new + 63 unchanged - 8 fixed = 63 total (was 71)
+1	checkstyle	10	The patch passed checkstyle in hbase-hadoop2-compat
+1	checkstyle	63	hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1	checkstyle	16	The patch passed checkstyle in hbase-mapreduce
+1	whitespace	0	The patch has no whitespace issues.
+1	shadedjars	261	patch has no errors when building our shaded downstream artifacts.
+1	hadoopcheck	760	Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1	findbugs	344	the patch passed
+1	javadoc	79	the patch passed
		_ Other Tests _
+1	unit	172	hbase-common in the patch passed.
+1	unit	36	hbase-hadoop2-compat in the patch passed.
-1	unit	14981	hbase-server in the patch failed.
+1	unit	1360	hbase-mapreduce in the patch passed.
+1	asflicense	108	The patch does not generate ASF License warnings.
		20304

Subsystem	Report/Notes
Docker	Client=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/artifact/out/Dockerfile
GITHUB PR	#322
Optional Tests	dupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
uname	Linux b1781cd27745 4.4.0-137-generic #163-Ubuntu SMP Mon Sep 24 13:14:43 UTC 2018 x86_64 GNU/Linux
Build tool	maven
Personality	/testptch/patchprocess/precommit/personality/provided.sh
git revision	master / `605f8a1`
maven	version: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java	1.8.0_181
findbugs	v3.1.11
unit	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/artifact/out/patch-unit-hbase-server.txt
Test Results	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/testReport/
Max. process+thread count	5278 (vs. ulimit of 10000)
modules	C: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console output	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/console
Powered by	Apache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

jatsakthi · 2019-07-11T17:34:43Z

LGTM

Apache-HBase · 2019-07-13T02:08:04Z

💔 -1 overall

Vote	Subsystem	Runtime	Comment
0	reexec	88	Docker mode activated.
		_ Prechecks _
+1	hbaseanti	0	Patch does not have any anti-patterns.
+1	@author	0	The patch does not contain any @author tags.
+1	test4tests	0	The patch appears to include 7 new or modified test files.
		_ master Compile Tests _
0	mvndep	15	Maven dependency ordering for branch
+1	mvninstall	270	master passed
+1	compile	123	master passed
+1	checkstyle	141	master passed
+1	shadedjars	303	branch has no errors when building our shaded downstream artifacts.
+1	findbugs	387	master passed
+1	javadoc	89	master passed
		_ Patch Compile Tests _
0	mvndep	14	Maven dependency ordering for patch
+1	mvninstall	275	the patch passed
+1	compile	129	the patch passed
+1	javac	129	the patch passed
+1	checkstyle	28	hbase-common: The patch generated 0 new + 63 unchanged - 8 fixed = 63 total (was 71)
+1	checkstyle	12	The patch passed checkstyle in hbase-hadoop2-compat
+1	checkstyle	83	hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1	checkstyle	19	The patch passed checkstyle in hbase-mapreduce
+1	whitespace	0	The patch has no whitespace issues.
+1	shadedjars	303	patch has no errors when building our shaded downstream artifacts.
+1	hadoopcheck	847	Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1	findbugs	413	the patch passed
+1	javadoc	93	the patch passed
		_ Other Tests _
+1	unit	182	hbase-common in the patch passed.
+1	unit	35	hbase-hadoop2-compat in the patch passed.
-1	unit	15663	hbase-server in the patch failed.
+1	unit	1726	hbase-mapreduce in the patch passed.
+1	asflicense	147	The patch does not generate ASF License warnings.
		21776

Subsystem	Report/Notes
Docker	Client=18.09.7 Server=18.09.7 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/artifact/out/Dockerfile
GITHUB PR	#322
Optional Tests	dupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
uname	Linux 14577bb991f8 4.15.0-52-generic #56-Ubuntu SMP Tue Jun 4 22:49:08 UTC 2019 x86_64 GNU/Linux
Build tool	maven
Personality	/testptch/patchprocess/precommit/personality/provided.sh
git revision	master / `438bf32`
maven	version: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java	1.8.0_181
findbugs	v3.1.11
unit	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/artifact/out/patch-unit-hbase-server.txt
Test Results	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/testReport/
Max. process+thread count	5437 (vs. ulimit of 10000)
modules	C: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console output	https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/console
Powered by	Apache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

HBASE-22586 Javadoc Warnings related to @param tag

e67cf2b

murtazahassan123 force-pushed the HBASE-22586 branch from 6cfcbff to e67cf2b Compare June 28, 2019 15:57

HorizonNet requested changes Jun 28, 2019

View reviewed changes

HBASE-22586 Javadoc Warnings related to @param tag, fixed some issues…

43ec434

… according to Jan's comments

jatsakthi reviewed Jul 3, 2019

View reviewed changes

HorizonNet reviewed Jul 4, 2019

View reviewed changes

HBASE-22586 made changes according to Jan's and Sakhti's comments

1f90991

jatsakthi approved these changes Jul 11, 2019

View reviewed changes

HorizonNet approved these changes Jul 13, 2019

View reviewed changes

HorizonNet merged commit 8defea9 into apache:master Jul 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HBASE-22586 Javadoc Warnings related to @param tag #322

HBASE-22586 Javadoc Warnings related to @param tag #322

murtazahassan123 commented Jun 18, 2019

HorizonNet commented Jun 22, 2019

jatsakthi commented Jun 27, 2019

murtazahassan123 commented Jun 28, 2019

Apache-HBase commented Jun 28, 2019

HorizonNet left a comment

murtazahassan123 commented Jul 1, 2019

Apache-HBase commented Jul 1, 2019

saintstack commented Jul 1, 2019

Apache-HBase commented Jul 2, 2019

jatsakthi left a comment

murtazahassan123 commented Jul 4, 2019

HorizonNet Jul 4, 2019

HorizonNet commented Jul 4, 2019

murtazahassan123 commented Jul 4, 2019

murtazahassan123 commented Jul 8, 2019

Apache-HBase commented Jul 8, 2019

jatsakthi commented Jul 11, 2019

Apache-HBase commented Jul 13, 2019

HBASE-22586 Javadoc Warnings related to @param tag #322

HBASE-22586 Javadoc Warnings related to @param tag #322

Conversation

murtazahassan123 commented Jun 18, 2019

HorizonNet commented Jun 22, 2019

jatsakthi commented Jun 27, 2019

murtazahassan123 commented Jun 28, 2019

Apache-HBase commented Jun 28, 2019

HorizonNet left a comment

Choose a reason for hiding this comment

murtazahassan123 commented Jul 1, 2019

Apache-HBase commented Jul 1, 2019

saintstack commented Jul 1, 2019

Apache-HBase commented Jul 2, 2019

jatsakthi left a comment

Choose a reason for hiding this comment

murtazahassan123 commented Jul 4, 2019

HorizonNet Jul 4, 2019

Choose a reason for hiding this comment

HorizonNet commented Jul 4, 2019

murtazahassan123 commented Jul 4, 2019

murtazahassan123 commented Jul 8, 2019

Apache-HBase commented Jul 8, 2019

jatsakthi commented Jul 11, 2019

Apache-HBase commented Jul 13, 2019