You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@metron.apache.org by mattf-horton <gi...@git.apache.org> on 2017/01/17 08:31:14 UTC

[GitHub] incubator-metron pull request #418: METRON-666 Fix javadoc doclint errors

GitHub user mattf-horton opened a pull request:

    https://github.com/apache/incubator-metron/pull/418

    METRON-666 Fix javadoc doclint errors

    Fixes for Java 8 javadocs automatic doclint problems:
    - replaced many uses of `<p/>` and `</p>` with simple uses of `<p>`
    - wrapped uses of `<` or `>`  in `{@literal}` or equivalent
    - a couple actual errors like \@return with no description or \@throws when nothing thrown


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mattf-horton/incubator-metron METRON-666

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-metron/pull/418.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #418
    
----
commit a8a192ebff6598d08400320731b28a913ab0c417
Author: mattf-horton <mf...@hortonworks.com>
Date:   2017-01-17T08:22:08Z

    METRON-666 Fix javadoc doclint errors

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    Do we need any changes, to commit these modest fixes to javadoc comments?  I'd like to experiment with adding javadocs to the doc site.  Thanks.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Re: [GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by Otto Fowler <ot...@gmail.com>.
Just a comment on this ( sorry it is late, I’m on jury duty ), but I did a
lot of work on the integration test stuff, with the runners and all, but
did not change anything wrt to integration tests.

I did see a lot of variance with the tests specifically in travis, due to
different latencies with expected items returning from kafka vs. the way
the test was written to expect them ( in other tests ).

Something to keep in mind.


On January 17, 2017 at 11:11:53, cestella (git@git.apache.org) wrote:

Github user cestella commented on the issue:

https://github.com/apache/incubator-metron/pull/418

So, one comment here for posterity and to make sure we're all on the same
page. This error started happening yesterday to my PR (#417). Here's what
happened:
* @mmiklavc asked for a doc change to a `README.md`
* Upon that commit, the SolrIntegrationTest failed because it timed out.
* I ran it 5 times in succession locally and noted that the total time was
around the same as historically (32 - 35 minutes)
* Meanwhile, I updated the test to be a bit more permissive timeout-wise
for the IndexingIntegrationTests

I concluded that it was travis latency based on:
* It is sporadic on travis but not locally
* Performance regressions did not appear locally
* It appeared suddenly on #417 after a no-code-change commit.

Just pointing out when I noticed this and some context.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    So, one comment here for posterity and to make sure we're all on the same page.  This error started happening yesterday to my PR (#417).  Here's what happened:
    * @mmiklavc asked for a doc change to a `README.md`
    * Upon that commit, the SolrIntegrationTest failed because it timed out.
    * I ran it 5 times in succession locally and noted that the total time was around the same as historically (32 - 35 minutes)
    * Meanwhile, I updated the test to be a bit more permissive timeout-wise for the IndexingIntegrationTests
    
    I concluded that it was travis latency based on:
    * It is sporadic on travis but not locally
    * Performance regressions did not appear locally
    * It appeared suddenly on #417 after a no-code-change commit.
    
    Just pointing out when I noticed this and some context.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron pull request #418: METRON-666 Fix javadoc doclint errors

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/incubator-metron/pull/418


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron pull request #418: METRON-666 Fix javadoc doclint errors

Posted by mattf-horton <gi...@git.apache.org>.
GitHub user mattf-horton reopened a pull request:

    https://github.com/apache/incubator-metron/pull/418

    METRON-666 Fix javadoc doclint errors

    Fixes for Java 8 javadocs automatic doclint problems:
    - replaced many uses of `<p/>` and `</p>` with simple uses of `<p>`
    - wrapped uses of `<` or `>`  in `{@literal}` or equivalent
    - a couple actual errors like \@return with no description or \@throws when nothing thrown


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mattf-horton/incubator-metron METRON-666

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-metron/pull/418.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #418
    
----
commit a8a192ebff6598d08400320731b28a913ab0c417
Author: mattf-horton <mf...@hortonworks.com>
Date:   2017-01-17T08:22:08Z

    METRON-666 Fix javadoc doclint errors

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by ottobackwards <gi...@git.apache.org>.
Github user ottobackwards commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    +1



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by JonZeolla <gi...@git.apache.org>.
Github user JonZeolla commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    Yeah, it looks like the latest master build failed as well.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    Travis is back to normal.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    @nickwallen replied on the dev list.  Replicating here for posterity:
    @nickwallen said:
    This is a self-imposed limit, no? See ComponentRunner.java:131.  Do we just
    need to give Travis some more time?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Re: [GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by Nick Allen <ni...@nickallen.org>.
>
> Tests in error:
> test(org.apache.metron.solr.integration.SolrIndexingIntegrationTest): Took
> too long to complete: 150963 > 150000


This is a self-imposed limit, no? See ComponentRunner.java:131.  Do we just
need to give Travis some more time?

On Tue, Jan 17, 2017 at 10:05 AM, JJ Meyer <jj...@gmail.com> wrote:

> I am not too familiar with the methods they use, but I believe they try and
> split up tasks based on the dependency tree. There are known issues though.
> To your point it won't be as simple as just switching travis' build config.
> If build times become an issue, it may be worth the investigation. Here is
> a link to a description of how it works (
> https://cwiki.apache.org/confluence/display/MAVEN/
> Parallel+builds+in+Maven+3
> ).
>
> On Tue, Jan 17, 2017 at 8:58 AM, Michael Miklavcic <
> michael.miklavcic@gmail.com> wrote:
>
> > How does Maven split tasks up these tasks? My only concern there is that
> we
> > have some robust integration test infrastructure data setup that may not
> be
> > thread-safe.
> >
> > On Tue, Jan 17, 2017 at 7:55 AM, jjmeyer0 <gi...@git.apache.org> wrote:
> >
> > > Github user jjmeyer0 commented on the issue:
> > >
> > >     https://github.com/apache/incubator-metron/pull/418
> > >
> > >     If time outs are going to continue being an issue, maybe we should
> > > start looking into using Maven's parallel builds. For example, when I
> > build
> > > locally I always do: `mvn -T 2C clean package`. This means build using
> 2
> > > threads per core. It usually cuts the build time in half for me.
> > >
> > >
> > > ---
> > > If your project is set up for it, you can reply to this email and have
> > your
> > > reply appear on GitHub as well. If your project does not have this
> > feature
> > > enabled and wishes so, or if the feature is enabled but not working,
> > please
> > > contact infrastructure at infrastructure@apache.org or file a JIRA
> > ticket
> > > with INFRA.
> > > ---
> > >
> >
>



-- 
Nick Allen <ni...@nickallen.org>

Re: [GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by JJ Meyer <jj...@gmail.com>.
I am not too familiar with the methods they use, but I believe they try and
split up tasks based on the dependency tree. There are known issues though.
To your point it won't be as simple as just switching travis' build config.
If build times become an issue, it may be worth the investigation. Here is
a link to a description of how it works (
https://cwiki.apache.org/confluence/display/MAVEN/Parallel+builds+in+Maven+3
).

On Tue, Jan 17, 2017 at 8:58 AM, Michael Miklavcic <
michael.miklavcic@gmail.com> wrote:

> How does Maven split tasks up these tasks? My only concern there is that we
> have some robust integration test infrastructure data setup that may not be
> thread-safe.
>
> On Tue, Jan 17, 2017 at 7:55 AM, jjmeyer0 <gi...@git.apache.org> wrote:
>
> > Github user jjmeyer0 commented on the issue:
> >
> >     https://github.com/apache/incubator-metron/pull/418
> >
> >     If time outs are going to continue being an issue, maybe we should
> > start looking into using Maven's parallel builds. For example, when I
> build
> > locally I always do: `mvn -T 2C clean package`. This means build using 2
> > threads per core. It usually cuts the build time in half for me.
> >
> >
> > ---
> > If your project is set up for it, you can reply to this email and have
> your
> > reply appear on GitHub as well. If your project does not have this
> feature
> > enabled and wishes so, or if the feature is enabled but not working,
> please
> > contact infrastructure at infrastructure@apache.org or file a JIRA
> ticket
> > with INFRA.
> > ---
> >
>

Re: [GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by Michael Miklavcic <mi...@gmail.com>.
How does Maven split tasks up these tasks? My only concern there is that we
have some robust integration test infrastructure data setup that may not be
thread-safe.

On Tue, Jan 17, 2017 at 7:55 AM, jjmeyer0 <gi...@git.apache.org> wrote:

> Github user jjmeyer0 commented on the issue:
>
>     https://github.com/apache/incubator-metron/pull/418
>
>     If time outs are going to continue being an issue, maybe we should
> start looking into using Maven's parallel builds. For example, when I build
> locally I always do: `mvn -T 2C clean package`. This means build using 2
> threads per core. It usually cuts the build time in half for me.
>
>
> ---
> If your project is set up for it, you can reply to this email and have your
> reply appear on GitHub as well. If your project does not have this feature
> enabled and wishes so, or if the feature is enabled but not working, please
> contact infrastructure at infrastructure@apache.org or file a JIRA ticket
> with INFRA.
> ---
>

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by jjmeyer0 <gi...@git.apache.org>.
Github user jjmeyer0 commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    If time outs are going to continue being an issue, maybe we should start looking into using Maven's parallel builds. For example, when I build locally I always do: `mvn -T 2C clean package`. This means build using 2 threads per core. It usually cuts the build time in half for me.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by justinleet <gi...@git.apache.org>.
Github user justinleet commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    I'm +1 on this, and definitely glad to see it.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    I'd kick travis by closing and reopening this PR.  I think this has to do with Travis being overloaded so the test is timing out.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    @nickwallen That would be one way to fix it, for sure.  I did bump the timeout a bit in #415, but it might could stand more.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by cestella <gi...@git.apache.org>.
Github user cestella commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    @jjmeyer0 It's timeouts in the test itself, so parallel execution wouldn't really help (this particular test sends data through and waits til it gets written out).


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron issue #418: METRON-666 Fix javadoc doclint errors

Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton commented on the issue:

    https://github.com/apache/incubator-metron/pull/418
  
    Kicking Travis. Bad Travis!


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-metron pull request #418: METRON-666 Fix javadoc doclint errors

Posted by mattf-horton <gi...@git.apache.org>.
Github user mattf-horton closed the pull request at:

    https://github.com/apache/incubator-metron/pull/418


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---