You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by Kirk Lund <ki...@gmail.com> on 2016/08/13 00:19:58 UTC

Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/
-----------------------------------------------------------

Review request for geode, Anthony Baker and Kevin Duling.


Bugs: GEODE-1648
    https://issues.apache.org/jira/browse/GEODE-1648


Repository: geode


Description
-------

This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.

Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):

SECURITY_ENABLED_COMPONENTS

static final java.lang.String SECURITY_ENABLED_COMPONENTS

The static String definition of the "security-enabled-components" property

Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.

This property has no effect unless a SECURITY_MANAGER is specified.

Options: "all","server","cluster","gateway","http","jmx"

Since: Geode 1.0

See Also:
Constant Field Values


Diffs
-----

  geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 

Diff: https://reviews.apache.org/r/51063/diff/


Testing
-------

clean build
manual inspection of javadocs in IDE and in browser


Thanks,

Kirk Lund


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Darrel Schneider <ds...@pivotal.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/#review145796
-----------------------------------------------------------


Ship it!




Ship It!

- Darrel Schneider


On Aug. 15, 2016, 12:56 p.m., Kirk Lund wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/51063/
> -----------------------------------------------------------
> 
> (Updated Aug. 15, 2016, 12:56 p.m.)
> 
> 
> Review request for geode, Anthony Baker and Kevin Duling.
> 
> 
> Bugs: GEODE-1648
>     https://issues.apache.org/jira/browse/GEODE-1648
> 
> 
> Repository: geode
> 
> 
> Description
> -------
> 
> This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.
> 
> Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):
> 
> SECURITY_ENABLED_COMPONENTS
> 
> static final java.lang.String SECURITY_ENABLED_COMPONENTS
> 
> The static String definition of the "security-enabled-components" property
> 
> Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.
> 
> This property has no effect unless a SECURITY_MANAGER is specified.
> 
> Options: "all","server","cluster","gateway","http","jmx"
> 
> Since: Geode 1.0
> 
> See Also:
> Constant Field Values
> 
> 
> Diffs
> -----
> 
>   geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 
> 
> Diff: https://reviews.apache.org/r/51063/diff/
> 
> 
> Testing
> -------
> 
> clean build
> manual inspection of javadocs in IDE and in browser
> 
> 
> Thanks,
> 
> Kirk Lund
> 
>


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Kirk Lund <ki...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/
-----------------------------------------------------------

(Updated Aug. 15, 2016, 7:56 p.m.)


Review request for geode, Anthony Baker and Kevin Duling.


Changes
-------

Again: trying to remove all changes to anything that is not security-enabled-components. Updating diff.


Bugs: GEODE-1648
    https://issues.apache.org/jira/browse/GEODE-1648


Repository: geode


Description
-------

This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.

Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):

SECURITY_ENABLED_COMPONENTS

static final java.lang.String SECURITY_ENABLED_COMPONENTS

The static String definition of the "security-enabled-components" property

Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.

This property has no effect unless a SECURITY_MANAGER is specified.

Options: "all","server","cluster","gateway","http","jmx"

Since: Geode 1.0

See Also:
Constant Field Values


Diffs (updated)
-----

  geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 

Diff: https://reviews.apache.org/r/51063/diff/


Testing
-------

clean build
manual inspection of javadocs in IDE and in browser


Thanks,

Kirk Lund


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Kirk Lund <ki...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/
-----------------------------------------------------------

(Updated Aug. 15, 2016, 7:52 p.m.)


Review request for geode, Anthony Baker and Kevin Duling.


Changes
-------

Removed unintended change from SERVER_BIND_ADDRESS javadoc (not sure how that got in there), isolating the change only to SECURITY_ENABLED_COMPONENTS. Updated diff.


Bugs: GEODE-1648
    https://issues.apache.org/jira/browse/GEODE-1648


Repository: geode


Description
-------

This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.

Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):

SECURITY_ENABLED_COMPONENTS

static final java.lang.String SECURITY_ENABLED_COMPONENTS

The static String definition of the "security-enabled-components" property

Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.

This property has no effect unless a SECURITY_MANAGER is specified.

Options: "all","server","cluster","gateway","http","jmx"

Since: Geode 1.0

See Also:
Constant Field Values


Diffs (updated)
-----

  geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 

Diff: https://reviews.apache.org/r/51063/diff/


Testing
-------

clean build
manual inspection of javadocs in IDE and in browser


Thanks,

Kirk Lund


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Kirk Lund <ki...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/
-----------------------------------------------------------

(Updated Aug. 15, 2016, 7:49 p.m.)


Review request for geode, Anthony Baker and Kevin Duling.


Changes
-------

And updating the diff once again to remove the other commit. I've moved the javadoc change to its own branch feature/GEODE-1648-javadoc.


Bugs: GEODE-1648
    https://issues.apache.org/jira/browse/GEODE-1648


Repository: geode


Description
-------

This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.

Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):

SECURITY_ENABLED_COMPONENTS

static final java.lang.String SECURITY_ENABLED_COMPONENTS

The static String definition of the "security-enabled-components" property

Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.

This property has no effect unless a SECURITY_MANAGER is specified.

Options: "all","server","cluster","gateway","http","jmx"

Since: Geode 1.0

See Also:
Constant Field Values


Diffs (updated)
-----

  geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 

Diff: https://reviews.apache.org/r/51063/diff/


Testing
-------

clean build
manual inspection of javadocs in IDE and in browser


Thanks,

Kirk Lund


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Kirk Lund <ki...@gmail.com>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/
-----------------------------------------------------------

(Updated Aug. 15, 2016, 7:46 p.m.)


Review request for geode, Anthony Baker and Kevin Duling.


Bugs: GEODE-1648
    https://issues.apache.org/jira/browse/GEODE-1648


Repository: geode


Description
-------

This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.

Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):

SECURITY_ENABLED_COMPONENTS

static final java.lang.String SECURITY_ENABLED_COMPONENTS

The static String definition of the "security-enabled-components" property

Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.

This property has no effect unless a SECURITY_MANAGER is specified.

Options: "all","server","cluster","gateway","http","jmx"

Since: Geode 1.0

See Also:
Constant Field Values


Diffs (updated)
-----

  geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 
  geode-wan/src/test/java/com/gemstone/gemfire/internal/cache/wan/parallel/ParallelWANPropagationClientServerDUnitTest.java f87475e 

Diff: https://reviews.apache.org/r/51063/diff/


Testing
-------

clean build
manual inspection of javadocs in IDE and in browser


Thanks,

Kirk Lund


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Kirk Lund <ki...@gmail.com>.

> On Aug. 15, 2016, 4:48 p.m., Darrel Schneider wrote:
> > geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java, line 1264
> > <https://reviews.apache.org/r/51063/diff/1/?file=1472383#file1472383line1264>
> >
> >     Would it be better for this <p> to be at the start of line 1265 instead of the end of line 1264? On line 1232 Description starts with <p><U>.
> >     It is not clear to me how the <p> without a later </p> work. I think they mean a single line paragraph. But then why does the Description on line 1232 not have a closing </p>?
> >     Also why does the Default on line 1269 just have a </p> without a beginning <p>?

Javadoc actually doesn't recognize the official HTML syntax for <p>. It only pays attention to the opening <p> and ignores the HTML close </p>. We could put it in but only using <p> is consistent with what I've been following in all new code and it's what's in the JDK src code. http://www.oracle.com/technetwork/articles/java/index-137868.html

I created blank lines to contain the <p> tags to hopefully make the intention clearer.


- Kirk


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/#review145765
-----------------------------------------------------------


On Aug. 15, 2016, 7:46 p.m., Kirk Lund wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/51063/
> -----------------------------------------------------------
> 
> (Updated Aug. 15, 2016, 7:46 p.m.)
> 
> 
> Review request for geode, Anthony Baker and Kevin Duling.
> 
> 
> Bugs: GEODE-1648
>     https://issues.apache.org/jira/browse/GEODE-1648
> 
> 
> Repository: geode
> 
> 
> Description
> -------
> 
> This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.
> 
> Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):
> 
> SECURITY_ENABLED_COMPONENTS
> 
> static final java.lang.String SECURITY_ENABLED_COMPONENTS
> 
> The static String definition of the "security-enabled-components" property
> 
> Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.
> 
> This property has no effect unless a SECURITY_MANAGER is specified.
> 
> Options: "all","server","cluster","gateway","http","jmx"
> 
> Since: Geode 1.0
> 
> See Also:
> Constant Field Values
> 
> 
> Diffs
> -----
> 
>   geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 
>   geode-wan/src/test/java/com/gemstone/gemfire/internal/cache/wan/parallel/ParallelWANPropagationClientServerDUnitTest.java f87475e 
> 
> Diff: https://reviews.apache.org/r/51063/diff/
> 
> 
> Testing
> -------
> 
> clean build
> manual inspection of javadocs in IDE and in browser
> 
> 
> Thanks,
> 
> Kirk Lund
> 
>


Re: Review Request 51063: GEODE-1648: fix new javadocs on security-enabled-components

Posted by Darrel Schneider <ds...@pivotal.io>.
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/51063/#review145765
-----------------------------------------------------------




geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java (line 1234)
<https://reviews.apache.org/r/51063/#comment212124>

    add "a" after "by ".



geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java (line 1264)
<https://reviews.apache.org/r/51063/#comment212125>

    Would it be better for this <p> to be at the start of line 1265 instead of the end of line 1264? On line 1232 Description starts with <p><U>.
    It is not clear to me how the <p> without a later </p> work. I think they mean a single line paragraph. But then why does the Description on line 1232 not have a closing </p>?
    Also why does the Default on line 1269 just have a </p> without a beginning <p>?


- Darrel Schneider


On Aug. 12, 2016, 5:19 p.m., Kirk Lund wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/51063/
> -----------------------------------------------------------
> 
> (Updated Aug. 12, 2016, 5:19 p.m.)
> 
> 
> Review request for geode, Anthony Baker and Kevin Duling.
> 
> 
> Bugs: GEODE-1648
>     https://issues.apache.org/jira/browse/GEODE-1648
> 
> 
> Repository: geode
> 
> 
> Description
> -------
> 
> This is a followup to the main commit for GEODE-1648 which added security-enabled-components to ConfigurationProperties but with incorrect javadocs.
> 
> Gradle-javadoc-html-in-chrome now reads like (but with some underlines, etc):
> 
> SECURITY_ENABLED_COMPONENTS
> 
> static final java.lang.String SECURITY_ENABLED_COMPONENTS
> 
> The static String definition of the "security-enabled-components" property
> 
> Description: This setting is a comma delimited list of SecurableComponents specifying which components will be secured by SECURITY_MANAGER.
> 
> This property has no effect unless a SECURITY_MANAGER is specified.
> 
> Options: "all","server","cluster","gateway","http","jmx"
> 
> Since: Geode 1.0
> 
> See Also:
> Constant Field Values
> 
> 
> Diffs
> -----
> 
>   geode-core/src/main/java/com/gemstone/gemfire/distributed/ConfigurationProperties.java 3157020 
> 
> Diff: https://reviews.apache.org/r/51063/diff/
> 
> 
> Testing
> -------
> 
> clean build
> manual inspection of javadocs in IDE and in browser
> 
> 
> Thanks,
> 
> Kirk Lund
> 
>