zookeeper-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andor Molnar <an...@apache.org>
Subject Re: Intellij Idea warning as error with -Xdoclint
Date Tue, 16 Jul 2019 13:57:58 GMT
Sure.

https://issues.apache.org/jira/browse/ZOOKEEPER-3463

Andor



> On 2019. Jul 16., at 15:32, Enrico Olivelli <eolivelli@gmail.com> wrote:
> 
> Il giorno mar 16 lug 2019 alle ore 14:59 Andor Molnar <andor@apache.org> ha
> scritto:
> 
>> It works for me with the following maven compiler options:
>> 
>> <configuration>
>>   <showWarnings>true</showWarnings>
>>   <compilerArgs>
>>     ...
>>     <compilerArg>-Xdoclint:-missing</compilerArg>
>>     ...
>>  </compilerArgs>
>> </configuration>
>> 
> 
> Can please you send a patch ?
> 
> I am +1 in adding such configuration
> 
> Good catch
> 
> Enrico
> 
> 
>> 
>> Andor
>> 
>> 
>> 
>>> On 2019. Jul 16., at 14:40, Andor Molnar <andor@apache.org> wrote:
>>> 
>>> Maven default:
>>> 
>>> <showWarnings>        boolean 2.0
>>> Set to true to show compilation warnings.
>>> Default value is: false.
>>> 
>>> Andor
>>> 
>>> 
>>> 
>>>> On 2019. Jul 16., at 14:33, Andor Molnar <andor@apache.org> wrote:
>>>> 
>>>> ‘-nowarn’ disables all warning messages.
>>>> Where does it come from?
>>>> 
>>>> Andor
>>>> 
>>>> 
>>>> 
>>>>> On 2019. Jul 16., at 14:30, Enrico Olivelli <eolivelli@gmail.com>
>> wrote:
>>>>> 
>>>>> I am running inside zookeeper-server
>>>>> mvn compile -X
>>>>> 
>>>>> and I see:
>>>>> 
>>>>> [DEBUG] Command line options:
>>>>> [DEBUG] Command line options:
>>>>> [DEBUG] -d /home/username/dev/zookeeper/zookeeper-server/target/classes
>>>>> -classpath
>>>>> 
>> /home/username/dev/zookeeper/zookeeper-server/target/classes:/home/username/.m2/repository/com/github/spotbugs/spotbugs-annotations/3.1.9/spotbugs-annotations-3.1.9.jar:/home/username/.m2/repository/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar:/home/username/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/home/username/.m2/repository/org/apache/zookeeper/zookeeper-jute/3.6.0-SNAPSHOT/zookeeper-jute-3.6.0-SNAPSHOT.jar:/home/username/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/home/username/.m2/repository/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/home/username/.m2/repository/io/netty/netty-all/4.1.36.Final/netty-all-4.1.36.Final.jar:/home/username/.m2/repository/org/slf4j/slf4j-api/1.7.25/slf4j-api-1.7.25.jar:/home/username/.m2/repository/org/slf4j/slf4j-log4j12/1.7.25/slf4j-log4j12-1.7.25.jar:/home/username/.m2/repository/org/eclipse/jetty/jetty-server/9.4.17.v20190418/jetty-server-9.4.17.v20190418.jar:/home/username/.m2/repository/javax/servlet/javax.servlet-api/3.1.0/javax.servlet-api-3.1.0.jar:/home/username/.m2/repository/org/eclipse/jetty/jetty-http/9.4.17.v20190418/jetty-http-9.4.17.v20190418.jar:/home/username/.m2/repository/org/eclipse/jetty/jetty-util/9.4.17.v20190418/jetty-util-9.4.17.v20190418.jar:/home/username/.m2/repository/org/eclipse/jetty/jetty-io/
>> 9.4.17.
>> v20190418/jetty-io-9.4.17.v20190418.jar:/home/username/.m2/repository/org/eclipse/jetty/jetty-servlet/
>> 9.4.17.
>> v20190418/jetty-servlet-9.4.17.v20190418.jar:/home/username/.m2/repository/org/eclipse/jetty/jetty-security/9.4.17.v20190418/jetty-security-9.4.17.v20190418.jar:/home/username/.m2/repository/com/fasterxml/jackson/core/jackson-databind/
>>>>> 
>> 2.9.9.1/jackson-databind-2.9.9.1.jar:/home/username/.m2/repository/com/fasterxml/jackson/core/jackson-annotations/2.9.0/jackson-annotations-2.9.0.jar:/home/username/.m2/repository/com/fasterxml/jackson/core/jackson-core/2.9.9/jackson-core-2.9.9.jar:/home/username/.m2/repository/com/googlecode/json-simple/json-simple/1.1.1/json-simple-1.1.1.jar:/home/username/.m2/repository/jline/jline/2.11/jline-2.11.jar:/home/username/.m2/repository/io/dropwizard/metrics/metrics-core/3.2.5/metrics-core-3.2.5.jar:/home/username/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/home/username/.m2/repository/org/xerial/snappy/snappy-java/1.1.7/snappy-java-1.1.7.jar
>> :
>>>>> -sourcepath
>>>>> 
>> /home/username/dev/zookeeper/zookeeper-server/src/main/java:/home/username/dev/zookeeper/zookeeper-server/target/generated-sources/java:/home/username/dev/zookeeper/zookeeper-server/target/generated-sources/annotations:
>>>>> -s
>>>>> 
>> /home/username/dev/zookeeper/zookeeper-server/target/generated-sources/annotations
>>>>> -g -nowarn -target 1.8 -source 1.8 -encoding UTF-8 -Werror
>>>>> -Xlint:deprecation -Xlint:unchecked -Xdoclint -Xpkginfo:always
>>>>> 
>>>>> maybe it is the '-nowarn' option ?
>>>>> 
>>>>> Enrico
>>>>> 
>>>>> 
>>>>> Il giorno mar 16 lug 2019 alle ore 14:23 Norbert Kalmar
>>>>> <nkalmar@cloudera.com.invalid> ha scritto:
>>>>> 
>>>>>> I'm guessing you are using the bundled maven (that's the default).
>> What
>>>>>> about if you change to your mvn install under
>>>>>> Build,Execution,Deployment/Build tools/maven
>>>>>> 
>>>>>> I always found IDE integrated tools to be troublesome. Git, maven,
>> java
>>>>>> runtime etc.
>>>>>> 
>>>>>> Regards,
>>>>>> Norbert
>>>>>> 
>>>>>> On Tue, Jul 16, 2019 at 1:59 PM Andor Molnar <andor@apache.org>
>> wrote:
>>>>>> 
>>>>>>> Idea cannot build ZooKeeper out-of-the-box. Here’s the error
message
>> when
>>>>>>> trying to build zookeeper-server:
>>>>>>> 
>>>>>>> 
>>>>>>> 
>>>>>> 
>> /Users/andormolnar/git/my-zookeeper/zookeeper-server/src/main/java/org/apache/zookeeper/server/command/StatCommand.java
>>>>>>> Warning:(19, 1) java: documentation comment not expected here
>>>>>>> Warning:(33, 8) java: no comment
>>>>>>> Warning:(34, 33) java: no comment
>>>>>>> Warning:(36, 17) java: no comment
>>>>>>> Warning:(37, 12) java: no comment
>>>>>>> Error:java: warnings found and -Werror specified
>>>>>>> 
>>>>>>> There’re lots of others, I just picked StatCommand.java as
an
>> example.
>>>>>>> 
>>>>>>> Idea is running the standard Javac compiler with the arguments
>> imported
>>>>>>> from Maven settings:
>>>>>>> javac -Werror -Xlint:deprecation -Xlint:unchecked -Xdoclint
>>>>>>> -Xpkginfo:always
>>>>>>> 
>>>>>>> thanks,
>>>>>>> Andor
>>>>>>> 
>>>>>>> 
>>>>>>> 
>>>>>>>> On 2019. Jul 16., at 13:37, Enrico Olivelli <eolivelli@gmail.com>
>>>>>> wrote:
>>>>>>>> 
>>>>>>>> Il giorno mar 16 lug 2019 alle ore 07:44 Andor Molnar <
>>>>>> andor@apache.org>
>>>>>>> ha
>>>>>>>> scritto:
>>>>>>>> 
>>>>>>>>> Yes, my main concern is: why does the maven succeed,
if we're still
>>>>>>>>> having javadoc issues?
>>>>>>>>> 
>>>>>>>> 
>>>>>>>> if I run in zookeeper-server this command I can't find any
WARNING
>> or
>>>>>>> ERROR
>>>>>>>> mvn javadoc:javadoc
>>>>>>>> 
>>>>>>>> only this ignorable one (I think)
>>>>>>>> INFO] --- maven-javadoc-plugin:3.0.1:javadoc (default-cli)
@
>> zookeeper
>>>>>>> ---
>>>>>>>> [ERROR] Error fetching link:
>>>>>>>> 
>>>>>>> 
>>>>>> 
>> /home/diennea.lan/enrico.olivelli/dev/zookeeper/zookeeper-jute/target/site/apidocs/package-list.
>>>>>>>> Ignored it.
>>>>>>>> 
>>>>>>>> and javadocs are generated correctly
>>>>>>>> 
>>>>>>>> Does Idea fail the build  ? do you have logs to share ? (I
don't
>> have
>>>>>>> Idea,
>>>>>>>> I am using NetBeans that apparently runs maven from the command
line
>>>>>> when
>>>>>>>> building)
>>>>>>>> 
>>>>>>>> Enrico
>>>>>>>> 
>>>>>>>> 
>>>>>>>> 
>>>>>>>>> 
>>>>>>>>> Andor
>>>>>>>>> 
>>>>>>>>> 
>>>>>>>>> -----Original Message-----
>>>>>>>>> From: Enrico Olivelli <eolivelli@gmail.com>
>>>>>>>>> Reply-To: dev@zookeeper.apache.org
>>>>>>>>> To: dev@zookeeper.apache.org
>>>>>>>>> Subject: Re: Intellij Idea warning as error with -Xdoclint
>>>>>>>>> Date: Mon, 15 Jul 2019 21:58:09 +0200
>>>>>>>>> 
>>>>>>>>> Il lun 15 lug 2019, 13:53 Andor Molnar <
>>>>>>>>> andor@apache.org
>>>>>>>>>> ha scritto:
>>>>>>>>> 
>>>>>>>>>> Hi Enrico,
>>>>>>>>>> 
>>>>>>>>>> This is still an issue for me in IDEA:
>>>>>>>>>> 
>>>>>>>>>> Javadoc problems found in zookeeper-jute and zookeeper-server
>>>>>>>>>> projects, so
>>>>>>>>>> the build eventually fails. Strange thing is that
running maven
>> from
>>>>>>>>>> command line doesn’t show any warning nor error.
>>>>>>>>>> 
>>>>>>>>>> From javac params -Werror and -Xdoclint I think IDEA’s
behaviour
>> is
>>>>>>>>>> correct.
>>>>>>>>>> 
>>>>>>>>>> Most warning messages in IDEA are about missing javadoc
comments,
>> so
>>>>>>>>>> changing it to "-Xdoclint:-missing” solves the
problem.
>>>>>>>>>> 
>>>>>>>>> 
>>>>>>>>> I can try to understand better.
>>>>>>>>> If I understand correctly your point is that apparently
Idea is
>>>>>> working
>>>>>>>>> as
>>>>>>>>> expected but Maven not and this is not good because CI
runs with
>>>>>> Maven.
>>>>>>>>> 
>>>>>>>>> I will be back with news.
>>>>>>>>> Hopefully we can fix javadocs and have a reliable way
to detect
>> issues
>>>>>>>>> on
>>>>>>>>> docs on CI/precommit/nightly
>>>>>>>>> 
>>>>>>>>> Enrico
>>>>>>>>> 
>>>>>>>>> 
>>>>>>>>>> Regards,
>>>>>>>>>> Andor
>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>>>> On 2019. Jun 20., at 20:28, Andor Molnar <
>>>>>>>>>>> andor@apache.org
>>>>>>>>>>>> wrote:
>>>>>>>>>>> 
>>>>>>>>>>> Done. #983 merged, problem gone.
>>>>>>>>>>> Thanks maoling!
>>>>>>>>>>> 
>>>>>>>>>>> Andor
>>>>>>>>>>> 
>>>>>>>>>>> 
>>>>>>>>>>> 
>>>>>>>>>>>> On 2019. Jun 20., at 15:43, maoling <
>>>>>>>>>>>> maoling199210191@sina.com
>>>>>>>>>>>>> wrote:
>>>>>>>>>>>> 
>>>>>>>>>>>> I also noticed this when running UT with
IDEA.may we can merge
>>>>>>>>>>>> this PR:
>>>>>>>>>>>> https://github.com/apache/zookeeper/pull/988
>>>>>>>>>>>> 
>>>>>>>>>>>> Or this one:
>>>>>>>>>>>> https://github.com/apache/zookeeper/pull/983
>>>>>>>>>>>> to remove
>>>>>>>>>> 
>>>>>>>>>> that warning.
>>>>>>>>>>>> 发送自 Windows 10 版邮件应用
>>>>>>>>>>>> 
>>>>>>>>>>>> 发件人: Andor Molnar
>>>>>>>>>>>> 发送时间: 2019年6月20日 5:46
>>>>>>>>>>>> 收件人: DevZooKeeper
>>>>>>>>>>>> 主题: Intellij Idea warning as error with
-Xdoclint
>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>> Hi Enrico,
>>>>>>>>>>>> 
>>>>>>>>>>>> I have the following error message in Idea
since -Xdoclint is
>>>>>>>>>>>> enabled
>>>>>>>>>> 
>>>>>>>>>> in the main pom.xml file:
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>>> /Users/andormolnar/git/my-zookeeper/zookeeper-
>>>>>>>>>> jute/src/main/java/org/apache/jute/Utils.java
>>>>>>>>>>>> Error:(194, 15) java: @param name not found
>>>>>>>>>>>> Error:(231, 15) java: @param name not found
>>>>>>>>>>>> 
>>>>>>>>>>>> Strange that I don’t see the same warnings
in console when
>>>>>>>>>>>> running ‘mvn
>>>>>>>>>> 
>>>>>>>>>> install’.
>>>>>>>>>>>> I confirm that removing “-Xdoclint” (or
fixing javadoc issues)
>>>>>>>>>>>> solves
>>>>>>>>>> 
>>>>>>>>>> the problem.
>>>>>>>>>>>> Andor
>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>>> 
>>>>>>>>> 
>>>>>>>>> 
>>>>>>> 
>>>>>>> 
>>>>>> 
>>>> 
>>> 
>> 
>> 


Mime
View raw message