You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mesos.apache.org by Bernardo Gomez Palacio <be...@gmail.com> on 2014/04/29 00:22:33 UTC
Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/
-----------------------------------------------------------
Review request for mesos and Mesos ReviewBot.
Bugs: MESOS-1259
https://issues.apache.org/jira/browse/MESOS-1259
Repository: mesos-git
Description
-------
[MESOS-1259]: Enrich the Java Docs in the src/java files.
The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
_javadoc_ task fails if there are _Classes_ which expose _public_ fields
or methods without proper _Java Documentation_. Note that by proper I am
referring to the structure that is validated by the _Javadoc Tool_.
In addition such documentation should facilitate the development of Java
based frameworks.
Diffs
-----
src/java/src/org/apache/mesos/Executor.java cacb4e9
src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
src/java/src/org/apache/mesos/Log.java d27e4f9
src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
src/java/src/org/apache/mesos/Scheduler.java 3043f60
src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
src/java/src/org/apache/mesos/state/State.java d14d79b
src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
Diff: https://reviews.apache.org/r/20807/diff/
Testing
-------
1. ./bootstrap && mkdir build && cd build && ../configure && make
2. The API Java Docs should be at build/src/java/target/apidocs
3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
. Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
Thanks,
Bernardo Gomez Palacio
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the
src/java files.
Posted by Bernardo Gomez Palacio <be...@gmail.com>.
Updated the RB https://reviews.apache.org/r/20807/ adding file attachments
that point to the patch that will be applied per file.
e.g.
MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
I hope this makes the review a bit less painful.
On Tue, Apr 29, 2014 at 11:55 AM, Benjamin Mahler <benjamin.mahler@gmail.com
> wrote:
> Thanks for the javadoc pointer, your indentation changes SGTM!
>
>
> On Mon, Apr 28, 2014 at 11:03 PM, Bernardo Gomez Palacio <
> bernardo.gomezpalacio@gmail.com> wrote:
>
>> This is an automatically generated e-mail. To reply, visit:
>> https://reviews.apache.org/r/20807/
>>
>> On April 29th, 2014, 1:03 a.m. UTC, *Ben Mahler* wrote:
>>
>> Thanks Bernardo, would you mind splitting up the diff so it's easier to review and commit incrementally?
>>
>> Took a quick glance:
>> 1. What is the indentation being used on @param, how about just keeping it consistent with Scheduler.java's existing style?
>> 2. Looks like there are some whitespace issues.
>>
>> I'll split it up per file.
>>
>> 1. The format, including indentation, is based on http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
>> I have no problem changing the format btw.
>>
>> 2. Will fix them, sorry for the slippage.
>>
>>
>> - Bernardo
>>
>> On April 28th, 2014, 10:22 p.m. UTC, Bernardo Gomez Palacio wrote:
>> Review request for mesos and Mesos ReviewBot.
>> By Bernardo Gomez Palacio.
>>
>> *Updated April 28, 2014, 10:22 p.m.*
>> *Bugs: * MESOS-1259 <https://issues.apache.org/jira/browse/MESOS-1259>
>> *Repository: * mesos-git
>> Description
>>
>> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>>
>> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
>> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
>> or methods without proper _Java Documentation_. Note that by proper I am
>> referring to the structure that is validated by the _Javadoc Tool_.
>>
>> In addition such documentation should facilitate the development of Java
>> based frameworks.
>>
>> Testing
>>
>> 1. ./bootstrap && mkdir build && cd build && ../configure && make
>> 2. The API Java Docs should be at build/src/java/target/apidocs
>> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>>
>> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>>
>> Diffs
>>
>> - src/java/src/org/apache/mesos/Executor.java (cacb4e9)
>> - src/java/src/org/apache/mesos/ExecutorDriver.java (56345df)
>> - src/java/src/org/apache/mesos/Log.java (d27e4f9)
>> - src/java/src/org/apache/mesos/MesosExecutorDriver.java (ce146cd)
>> - src/java/src/org/apache/mesos/MesosSchedulerDriver.java (3fd1eb5)
>> - src/java/src/org/apache/mesos/Scheduler.java (3043f60)
>> - src/java/src/org/apache/mesos/SchedulerDriver.java (ae2d915)
>> - src/java/src/org/apache/mesos/state/State.java (d14d79b)
>> - src/java/src/org/apache/mesos/state/ZooKeeperState.java (a21a4ae)
>>
>> View Diff <https://reviews.apache.org/r/20807/diff/>
>>
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the
src/java files.
Posted by Benjamin Mahler <be...@gmail.com>.
Thanks for the javadoc pointer, your indentation changes SGTM!
On Mon, Apr 28, 2014 at 11:03 PM, Bernardo Gomez Palacio <
bernardo.gomezpalacio@gmail.com> wrote:
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
>
> On April 29th, 2014, 1:03 a.m. UTC, *Ben Mahler* wrote:
>
> Thanks Bernardo, would you mind splitting up the diff so it's easier to review and commit incrementally?
>
> Took a quick glance:
> 1. What is the indentation being used on @param, how about just keeping it consistent with Scheduler.java's existing style?
> 2. Looks like there are some whitespace issues.
>
> I'll split it up per file.
>
> 1. The format, including indentation, is based on http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
> I have no problem changing the format btw.
>
> 2. Will fix them, sorry for the slippage.
>
>
> - Bernardo
>
> On April 28th, 2014, 10:22 p.m. UTC, Bernardo Gomez Palacio wrote:
> Review request for mesos and Mesos ReviewBot.
> By Bernardo Gomez Palacio.
>
> *Updated April 28, 2014, 10:22 p.m.*
> *Bugs: * MESOS-1259 <https://issues.apache.org/jira/browse/MESOS-1259>
> *Repository: * mesos-git
> Description
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
> Testing
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
> Diffs
>
> - src/java/src/org/apache/mesos/Executor.java (cacb4e9)
> - src/java/src/org/apache/mesos/ExecutorDriver.java (56345df)
> - src/java/src/org/apache/mesos/Log.java (d27e4f9)
> - src/java/src/org/apache/mesos/MesosExecutorDriver.java (ce146cd)
> - src/java/src/org/apache/mesos/MesosSchedulerDriver.java (3fd1eb5)
> - src/java/src/org/apache/mesos/Scheduler.java (3043f60)
> - src/java/src/org/apache/mesos/SchedulerDriver.java (ae2d915)
> - src/java/src/org/apache/mesos/state/State.java (d14d79b)
> - src/java/src/org/apache/mesos/state/ZooKeeperState.java (a21a4ae)
>
> View Diff <https://reviews.apache.org/r/20807/diff/>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Bernardo Gomez Palacio <be...@gmail.com>.
> On April 29, 2014, 1:03 a.m., Ben Mahler wrote:
> > Thanks Bernardo, would you mind splitting up the diff so it's easier to review and commit incrementally?
> >
> > Took a quick glance:
> > 1. What is the indentation being used on @param, how about just keeping it consistent with Scheduler.java's existing style?
> > 2. Looks like there are some whitespace issues.
I'll split it up per file.
1. The format, including indentation, is based on http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
I have no problem changing the format btw.
2. Will fix them, sorry for the slippage.
- Bernardo
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/#review41659
-----------------------------------------------------------
On April 28, 2014, 10:22 p.m., Bernardo Gomez Palacio wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
> -----------------------------------------------------------
>
> (Updated April 28, 2014, 10:22 p.m.)
>
>
> Review request for mesos and Mesos ReviewBot.
>
>
> Bugs: MESOS-1259
> https://issues.apache.org/jira/browse/MESOS-1259
>
>
> Repository: mesos-git
>
>
> Description
> -------
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
>
> Diffs
> -----
>
> src/java/src/org/apache/mesos/Executor.java cacb4e9
> src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
> src/java/src/org/apache/mesos/Log.java d27e4f9
> src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
> src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
> src/java/src/org/apache/mesos/Scheduler.java 3043f60
> src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
> src/java/src/org/apache/mesos/state/State.java d14d79b
> src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
>
> Diff: https://reviews.apache.org/r/20807/diff/
>
>
> Testing
> -------
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
>
> Thanks,
>
> Bernardo Gomez Palacio
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the
src/java files.
Posted by Bernardo Gomez Palacio <be...@gmail.com>.
Will do. One diff per file? I followed the convention found in the jdk but
have no problem adjusting to the one you mention.
On Monday, April 28, 2014, Ben Mahler <be...@gmail.com> wrote:
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
>
> Thanks Bernardo, would you mind splitting up the diff so it's easier to review and commit incrementally?
>
> Took a quick glance:
> 1. What is the indentation being used on @param, how about just keeping it consistent with Scheduler.java's existing style?
> 2. Looks like there are some whitespace issues.
>
>
> - Ben Mahler
>
> On April 28th, 2014, 10:22 p.m. UTC, Bernardo Gomez Palacio wrote:
> Review request for mesos and Mesos ReviewBot.
> By Bernardo Gomez Palacio.
>
> *Updated April 28, 2014, 10:22 p.m.*
> *Bugs: * MESOS-1259 <https://issues.apache.org/jira/browse/MESOS-1259>
> *Repository: * mesos-git
> Description
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
> Testing
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
> Diffs
>
> - src/java/src/org/apache/mesos/Executor.java (cacb4e9)
> - src/java/src/org/apache/mesos/ExecutorDriver.java (56345df)
> - src/java/src/org/apache/mesos/Log.java (d27e4f9)
> - src/java/src/org/apache/mesos/MesosExecutorDriver.java (ce146cd)
> - src/java/src/org/apache/mesos/MesosSchedulerDriver.java (3fd1eb5)
> - src/java/src/org/apache/mesos/Scheduler.java (3043f60)
> - src/java/src/org/apache/mesos/SchedulerDriver.java (ae2d915)
> - src/java/src/org/apache/mesos/state/State.java (d14d79b)
> - src/java/src/org/apache/mesos/state/ZooKeeperState.java (a21a4ae)
>
> View Diff <https://reviews.apache.org/r/20807/diff/>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Ben Mahler <be...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/#review41659
-----------------------------------------------------------
Thanks Bernardo, would you mind splitting up the diff so it's easier to review and commit incrementally?
Took a quick glance:
1. What is the indentation being used on @param, how about just keeping it consistent with Scheduler.java's existing style?
2. Looks like there are some whitespace issues.
- Ben Mahler
On April 28, 2014, 10:22 p.m., Bernardo Gomez Palacio wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
> -----------------------------------------------------------
>
> (Updated April 28, 2014, 10:22 p.m.)
>
>
> Review request for mesos and Mesos ReviewBot.
>
>
> Bugs: MESOS-1259
> https://issues.apache.org/jira/browse/MESOS-1259
>
>
> Repository: mesos-git
>
>
> Description
> -------
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
>
> Diffs
> -----
>
> src/java/src/org/apache/mesos/Executor.java cacb4e9
> src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
> src/java/src/org/apache/mesos/Log.java d27e4f9
> src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
> src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
> src/java/src/org/apache/mesos/Scheduler.java 3043f60
> src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
> src/java/src/org/apache/mesos/state/State.java d14d79b
> src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
>
> Diff: https://reviews.apache.org/r/20807/diff/
>
>
> Testing
> -------
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
>
> Thanks,
>
> Bernardo Gomez Palacio
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Mesos ReviewBot <de...@mesos.apache.org>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/#review42106
-----------------------------------------------------------
Patch looks great!
Reviews applied: [20807]
All tests passed.
- Mesos ReviewBot
On April 30, 2014, 11:01 p.m., Bernardo Gomez Palacio wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
> -----------------------------------------------------------
>
> (Updated April 30, 2014, 11:01 p.m.)
>
>
> Review request for mesos and Mesos ReviewBot.
>
>
> Bugs: MESOS-1259
> https://issues.apache.org/jira/browse/MESOS-1259
>
>
> Repository: mesos-git
>
>
> Description
> -------
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
>
> Diffs
> -----
>
> src/java/src/org/apache/mesos/Executor.java cacb4e9
> src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
> src/java/src/org/apache/mesos/Log.java d27e4f9
> src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
> src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
> src/java/src/org/apache/mesos/Scheduler.java 3043f60
> src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
> src/java/src/org/apache/mesos/state/State.java d14d79b
> src/java/src/org/apache/mesos/state/Variable.java 8e1ca69
> src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
>
> Diff: https://reviews.apache.org/r/20807/diff/
>
>
> Testing
> -------
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
>
> File Attachments
> ----------------
>
> MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/50071e59-be40-4b9b-924f-83c8814645b1__MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/2de4f9eb-5400-407b-b052-748e6694e1aa__MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/12c78172-34f0-4842-a422-b83b10d5dc95__MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/445f44bc-e3a8-4d5d-bd26-67287530a989__MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/9b37a375-145b-464f-9c48-350f35c998b9__MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/43416013-296d-4f31-9fe3-94e6a40c7f3d__MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Log.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/7df3d908-9d83-40d8-9747-12e92472d0f2__MESOS-1259-src-java-src-org-apache-mesos-Log.java
> MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/14e31044-3d03-4c2b-a72e-9fbd00a67e24__MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Executor.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/4bfdd153-ef27-45f2-92b5-22443912cb0b__MESOS-1259-src-java-src-org-apache-mesos-Executor.java
>
>
> Thanks,
>
> Bernardo Gomez Palacio
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Bernardo Gomez Palacio <be...@gmail.com>.
> On May 2, 2014, 12:32 a.m., Ben Mahler wrote:
> > Hey Bernardo, have you used ./support/post-reviews.py? It will make this process really easy!
> >
> > It will send out a review for each commit in your branch. This means you can have a commit for each file and send them out automatically using post-reviews (it will ensure the parent patches are correct)! To make changes you can then use interactive rebasing (git rebase -i).
> >
> > Sorry for all the trouble, but I noticed there's new documentation here as well in Log.java (which jie should review). For the purely stylistic changes, feel free to keep those lumped together.
> >
> > Looking forward to getting this committed!
Hi Ben, thanks for the pointers. I did spent all day working with RB and the `./support/post-reviews.py` adapted for RBTool 0.6, available at https://gist.github.com/berngp/1318aee8f8939e8302b8#file-post-reviews-2-py. I have been unable to create what you mention in RB regardless of having several commits, one per file, as you suggested. Any help on understanding why would RB throw such errors would be highly appreciated.
The branch with the commits per file is at https://github.com/berngp/mesos/tree/feature/MESOS-1259.
The error that I am getting from Review Board is https://gist.github.com/berngp/1318aee8f8939e8302b8#file-feature_mesos-1259-out.
- Bernardo
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/#review41984
-----------------------------------------------------------
On April 30, 2014, 11:01 p.m., Bernardo Gomez Palacio wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
> -----------------------------------------------------------
>
> (Updated April 30, 2014, 11:01 p.m.)
>
>
> Review request for mesos and Mesos ReviewBot.
>
>
> Bugs: MESOS-1259
> https://issues.apache.org/jira/browse/MESOS-1259
>
>
> Repository: mesos-git
>
>
> Description
> -------
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
>
> Diffs
> -----
>
> src/java/src/org/apache/mesos/Executor.java cacb4e9
> src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
> src/java/src/org/apache/mesos/Log.java d27e4f9
> src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
> src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
> src/java/src/org/apache/mesos/Scheduler.java 3043f60
> src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
> src/java/src/org/apache/mesos/state/State.java d14d79b
> src/java/src/org/apache/mesos/state/Variable.java 8e1ca69
> src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
>
> Diff: https://reviews.apache.org/r/20807/diff/
>
>
> Testing
> -------
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
>
> File Attachments
> ----------------
>
> MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/50071e59-be40-4b9b-924f-83c8814645b1__MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/2de4f9eb-5400-407b-b052-748e6694e1aa__MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/12c78172-34f0-4842-a422-b83b10d5dc95__MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/445f44bc-e3a8-4d5d-bd26-67287530a989__MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/9b37a375-145b-464f-9c48-350f35c998b9__MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/43416013-296d-4f31-9fe3-94e6a40c7f3d__MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Log.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/7df3d908-9d83-40d8-9747-12e92472d0f2__MESOS-1259-src-java-src-org-apache-mesos-Log.java
> MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/14e31044-3d03-4c2b-a72e-9fbd00a67e24__MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Executor.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/4bfdd153-ef27-45f2-92b5-22443912cb0b__MESOS-1259-src-java-src-org-apache-mesos-Executor.java
>
>
> Thanks,
>
> Bernardo Gomez Palacio
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Bernardo Gomez Palacio <be...@gmail.com>.
> On May 2, 2014, 12:32 a.m., Ben Mahler wrote:
> > Hey Bernardo, have you used ./support/post-reviews.py? It will make this process really easy!
> >
> > It will send out a review for each commit in your branch. This means you can have a commit for each file and send them out automatically using post-reviews (it will ensure the parent patches are correct)! To make changes you can then use interactive rebasing (git rebase -i).
> >
> > Sorry for all the trouble, but I noticed there's new documentation here as well in Log.java (which jie should review). For the purely stylistic changes, feel free to keep those lumped together.
> >
> > Looking forward to getting this committed!
>
> Bernardo Gomez Palacio wrote:
> Hi Ben, thanks for the pointers. I did spent all day working with RB and the `./support/post-reviews.py` adapted for RBTool 0.6, available at https://gist.github.com/berngp/1318aee8f8939e8302b8#file-post-reviews-2-py. I have been unable to create what you mention in RB regardless of having several commits, one per file, as you suggested. Any help on understanding why would RB throw such errors would be highly appreciated.
>
> The branch with the commits per file is at https://github.com/berngp/mesos/tree/feature/MESOS-1259.
>
> The error that I am getting from Review Board is https://gist.github.com/berngp/1318aee8f8939e8302b8#file-feature_mesos-1259-out.
Ben - Finally got RBTool working for me and just submitted a set of RR, one per file. Will close this RR and followup in the others.
- Bernardo
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/#review41984
-----------------------------------------------------------
On April 30, 2014, 11:01 p.m., Bernardo Gomez Palacio wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
> -----------------------------------------------------------
>
> (Updated April 30, 2014, 11:01 p.m.)
>
>
> Review request for mesos and Mesos ReviewBot.
>
>
> Bugs: MESOS-1259
> https://issues.apache.org/jira/browse/MESOS-1259
>
>
> Repository: mesos-git
>
>
> Description
> -------
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
>
> Diffs
> -----
>
> src/java/src/org/apache/mesos/Executor.java cacb4e9
> src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
> src/java/src/org/apache/mesos/Log.java d27e4f9
> src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
> src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
> src/java/src/org/apache/mesos/Scheduler.java 3043f60
> src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
> src/java/src/org/apache/mesos/state/State.java d14d79b
> src/java/src/org/apache/mesos/state/Variable.java 8e1ca69
> src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
>
> Diff: https://reviews.apache.org/r/20807/diff/
>
>
> Testing
> -------
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
>
> File Attachments
> ----------------
>
> MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/50071e59-be40-4b9b-924f-83c8814645b1__MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/2de4f9eb-5400-407b-b052-748e6694e1aa__MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/12c78172-34f0-4842-a422-b83b10d5dc95__MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/445f44bc-e3a8-4d5d-bd26-67287530a989__MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/9b37a375-145b-464f-9c48-350f35c998b9__MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/43416013-296d-4f31-9fe3-94e6a40c7f3d__MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Log.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/7df3d908-9d83-40d8-9747-12e92472d0f2__MESOS-1259-src-java-src-org-apache-mesos-Log.java
> MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/14e31044-3d03-4c2b-a72e-9fbd00a67e24__MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Executor.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/4bfdd153-ef27-45f2-92b5-22443912cb0b__MESOS-1259-src-java-src-org-apache-mesos-Executor.java
>
>
> Thanks,
>
> Bernardo Gomez Palacio
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Ben Mahler <be...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/#review41984
-----------------------------------------------------------
Hey Bernardo, have you used ./support/post-reviews.py? It will make this process really easy!
It will send out a review for each commit in your branch. This means you can have a commit for each file and send them out automatically using post-reviews (it will ensure the parent patches are correct)! To make changes you can then use interactive rebasing (git rebase -i).
Sorry for all the trouble, but I noticed there's new documentation here as well in Log.java (which jie should review). For the purely stylistic changes, feel free to keep those lumped together.
Looking forward to getting this committed!
- Ben Mahler
On April 30, 2014, 11:01 p.m., Bernardo Gomez Palacio wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/20807/
> -----------------------------------------------------------
>
> (Updated April 30, 2014, 11:01 p.m.)
>
>
> Review request for mesos and Mesos ReviewBot.
>
>
> Bugs: MESOS-1259
> https://issues.apache.org/jira/browse/MESOS-1259
>
>
> Repository: mesos-git
>
>
> Description
> -------
>
> [MESOS-1259]: Enrich the Java Docs in the src/java files.
>
> The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
> _javadoc_ task fails if there are _Classes_ which expose _public_ fields
> or methods without proper _Java Documentation_. Note that by proper I am
> referring to the structure that is validated by the _Javadoc Tool_.
>
> In addition such documentation should facilitate the development of Java
> based frameworks.
>
>
> Diffs
> -----
>
> src/java/src/org/apache/mesos/Executor.java cacb4e9
> src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
> src/java/src/org/apache/mesos/Log.java d27e4f9
> src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
> src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
> src/java/src/org/apache/mesos/Scheduler.java 3043f60
> src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
> src/java/src/org/apache/mesos/state/State.java d14d79b
> src/java/src/org/apache/mesos/state/Variable.java 8e1ca69
> src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
>
> Diff: https://reviews.apache.org/r/20807/diff/
>
>
> Testing
> -------
>
> 1. ./bootstrap && mkdir build && cd build && ../configure && make
> 2. The API Java Docs should be at build/src/java/target/apidocs
> 3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
>
> . Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
>
>
> File Attachments
> ----------------
>
> MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/50071e59-be40-4b9b-924f-83c8814645b1__MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
> MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/2de4f9eb-5400-407b-b052-748e6694e1aa__MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
> MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/12c78172-34f0-4842-a422-b83b10d5dc95__MESOS-1259-src-java-src-org-apache-mesos-state-State.java
> MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/445f44bc-e3a8-4d5d-bd26-67287530a989__MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/9b37a375-145b-464f-9c48-350f35c998b9__MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
> MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/43416013-296d-4f31-9fe3-94e6a40c7f3d__MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Log.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/7df3d908-9d83-40d8-9747-12e92472d0f2__MESOS-1259-src-java-src-org-apache-mesos-Log.java
> MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/14e31044-3d03-4c2b-a72e-9fbd00a67e24__MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
> MESOS-1259-src-java-src-org-apache-mesos-Executor.java
> https://reviews.apache.org/media/uploaded/files/2014/04/30/4bfdd153-ef27-45f2-92b5-22443912cb0b__MESOS-1259-src-java-src-org-apache-mesos-Executor.java
>
>
> Thanks,
>
> Bernardo Gomez Palacio
>
>
Re: Review Request 20807: [MESOS-1259]: Enrich the Java Docs in the src/java
files.
Posted by Bernardo Gomez Palacio <be...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/20807/
-----------------------------------------------------------
(Updated April 30, 2014, 11:01 p.m.)
Review request for mesos and Mesos ReviewBot.
Changes
-------
Submitted a patch per file, each patch's name reflects the name of the file that is referring to. e.g. MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
Bugs: MESOS-1259
https://issues.apache.org/jira/browse/MESOS-1259
Repository: mesos-git
Description
-------
[MESOS-1259]: Enrich the Java Docs in the src/java files.
The Maven _package_ task will depends on the _javadoc:javadoc_ task. The
_javadoc_ task fails if there are _Classes_ which expose _public_ fields
or methods without proper _Java Documentation_. Note that by proper I am
referring to the structure that is validated by the _Javadoc Tool_.
In addition such documentation should facilitate the development of Java
based frameworks.
Diffs (updated)
-----
src/java/src/org/apache/mesos/Executor.java cacb4e9
src/java/src/org/apache/mesos/ExecutorDriver.java 56345df
src/java/src/org/apache/mesos/Log.java d27e4f9
src/java/src/org/apache/mesos/MesosExecutorDriver.java ce146cd
src/java/src/org/apache/mesos/MesosSchedulerDriver.java 3fd1eb5
src/java/src/org/apache/mesos/Scheduler.java 3043f60
src/java/src/org/apache/mesos/SchedulerDriver.java ae2d915
src/java/src/org/apache/mesos/state/State.java d14d79b
src/java/src/org/apache/mesos/state/Variable.java 8e1ca69
src/java/src/org/apache/mesos/state/ZooKeeperState.java a21a4ae
Diff: https://reviews.apache.org/r/20807/diff/
Testing
-------
1. ./bootstrap && mkdir build && cd build && ../configure && make
2. The API Java Docs should be at build/src/java/target/apidocs
3. Open the index and navigate through the documentation. e.g. open build/src/java/target/apidocs/index.html
. Please note that as of now the Protos.* are not available for the Javadocs therefore we are unable to link any reference.
File Attachments (updated)
----------------
MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/50071e59-be40-4b9b-924f-83c8814645b1__MESOS-1259-src-java-src-org-apache-mesos-state-ZooKeeperState.java
MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/2de4f9eb-5400-407b-b052-748e6694e1aa__MESOS-1259-src-java-src-org-apache-mesos-state-Variable.java
MESOS-1259-src-java-src-org-apache-mesos-state-State.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/12c78172-34f0-4842-a422-b83b10d5dc95__MESOS-1259-src-java-src-org-apache-mesos-state-State.java
MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/445f44bc-e3a8-4d5d-bd26-67287530a989__MESOS-1259-src-java-src-org-apache-mesos-SchedulerDriver.java
MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/9b37a375-145b-464f-9c48-350f35c998b9__MESOS-1259-src-java-src-org-apache-mesos-Scheduler.java
MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/43416013-296d-4f31-9fe3-94e6a40c7f3d__MESOS-1259-src-java-src-org-apache-mesos-MesosSchedulerDriver.java
MESOS-1259-src-java-src-org-apache-mesos-Log.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/7df3d908-9d83-40d8-9747-12e92472d0f2__MESOS-1259-src-java-src-org-apache-mesos-Log.java
MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/14e31044-3d03-4c2b-a72e-9fbd00a67e24__MESOS-1259-src-java-src-org-apache-mesos-ExecutorDriver.java
MESOS-1259-src-java-src-org-apache-mesos-Executor.java
https://reviews.apache.org/media/uploaded/files/2014/04/30/4bfdd153-ef27-45f2-92b5-22443912cb0b__MESOS-1259-src-java-src-org-apache-mesos-Executor.java
Thanks,
Bernardo Gomez Palacio