Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 18:11:43 GMT, Naoto Sato wrote: >> or just "The length of the input" so that it is consistent with the >> description of the getInputLength method. > > That sounds good. Changed to "The length of the input." in the [most recent commit](https://github.com/openjdk/jdk/pull/3376/commits/9f36eec44dec7cd8f75f787c7d386e26d55e6826). - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 18:12:20 GMT, Naoto Sato wrote: >> This makes changes to the copyright headers of of the generated source files >> `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java`. >> These can be found under a jdk build in `support/gensrc` and the headers >> update after running `make jdk-image`. Perhaps the build is out of date? >> These changes are harder to track as the source is not checked in. > > That's right. Sorry for the false alarm. No worries, better safe than sorry! - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 18:04:48 GMT, Alan Bateman wrote: >> It could, maybe something like "The length of the input byte (or character) >> sequence." would work? > > or just "The length of the input" so that it is consistent with the > description of the getInputLength method. That sounds good. - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 17:58:58 GMT, Conor Cleary wrote: >> src/java.base/share/classes/java/nio/exceptions line 31: >> >>> 29: PACKAGE=java.nio >>> 30: # This year should only change if the generated source is modified. >>> 31: COPYRIGHT_YEARS="2000, 2021," >> >> Does not seem necessary, as I don't see any changes in java.nio package. > > This makes changes to the copyright headers of of the generated source files > `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java`. > These can be found under a jdk build in `support/gensrc` and the headers > update after running `make jdk-image`. Perhaps the build is out of date? > These changes are harder to track as the source is not checked in. That's right. Sorry for the false alarm. - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 14:40:48 GMT, Conor Cleary wrote: >> This fix addresses the following warnings which were generated by building >> JDK API documentation with the `-Xdoclint:all` option enabled: >> >> ./build/linux-x64/support/gensrc/java.base/java/nio/charset/IllegalCharsetNameException.java:47: >> warning: no comment >> private String charsetName; >>^ >> ./open/src/java.base/share/classes/java/nio/charset/MalformedInputException.java:44: >> warning: no comment >> private int inputLength; >> ^ >> ./open/src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java:44: >> warning: no comment >> private int inputLength; >> ^ >> ./build/linux-x64/support/gensrc/java.base/java/nio/charset/UnsupportedCharsetException.java:47: >> warning: no comment >> private String charsetName; >>^ >> ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: >> warning: no @param for s >> private void readObject(ObjectInputStream s) >> ^ >> ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: >> warning: no @throws for java.lang.ClassNotFoundException >> private void readObject(ObjectInputStream s) >> ^ >> ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:43: >> warning: no comment >> private final String file; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:44: >> warning: no comment >> private final String other; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:43: >> warning: no comment >> private int index; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:42: >> warning: no comment >> private String input; >>^ >> ./open/src/java.base/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java:43: >> warning: no comment >> private final String name; >> ^ >> Changes to >> [`genExceptions.sh`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) >> and the two >> [`exceptions`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) >> templates are to address the warnings concerned with >> `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java` >> which are generated when `make jdk-image` is run. A CSR will be filed in due >> course with respect to these changes. > > Conor Cleary has updated the pull request incrementally with one additional > commit since the last revision: > > 8264779: Simplified comments Marked as reviewed by alanb (Reviewer). - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 18:01:25 GMT, Conor Cleary wrote: >> src/java.base/share/classes/java/nio/charset/MalformedInputException.java >> line 45: >> >>> 43: >>> 44: /** >>> 45: * The length of the input byte sequence. >> >> Should this comment also refer to the character sequence? > > It could, maybe something like "The length of the input byte (or character) > sequence." would work? or just "The length of the input" so that it is consistent with the description of the getInputLength method. - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 16:09:22 GMT, Naoto Sato wrote: >> Conor Cleary has updated the pull request incrementally with one additional >> commit since the last revision: >> >> 8264779: Simplified comments > > src/java.base/share/classes/java/nio/charset/MalformedInputException.java > line 45: > >> 43: >> 44: /** >> 45: * The length of the input byte sequence. > > Should this comment also refer to the character sequence? It could, maybe something like "The length of the input byte (or character) sequence." would work? > src/java.base/share/classes/java/nio/exceptions line 31: > >> 29: PACKAGE=java.nio >> 30: # This year should only change if the generated source is modified. >> 31: COPYRIGHT_YEARS="2000, 2021," > > Does not seem necessary, as I don't see any changes in java.nio package. This makes changes to the copyright headers of of the generated source files `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java`. These can be found under a jdk build in `support/gensrc` and the headers update after running `make jdk-image`. Perhaps the build is out of date? These changes are harder to track as the source is not checked in. - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 14:40:48 GMT, Conor Cleary wrote: >> This fix addresses the following warnings which were generated by building >> JDK API documentation with the `-Xdoclint:all` option enabled: >> >> ./build/linux-x64/support/gensrc/java.base/java/nio/charset/IllegalCharsetNameException.java:47: >> warning: no comment >> private String charsetName; >>^ >> ./open/src/java.base/share/classes/java/nio/charset/MalformedInputException.java:44: >> warning: no comment >> private int inputLength; >> ^ >> ./open/src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java:44: >> warning: no comment >> private int inputLength; >> ^ >> ./build/linux-x64/support/gensrc/java.base/java/nio/charset/UnsupportedCharsetException.java:47: >> warning: no comment >> private String charsetName; >>^ >> ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: >> warning: no @param for s >> private void readObject(ObjectInputStream s) >> ^ >> ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: >> warning: no @throws for java.lang.ClassNotFoundException >> private void readObject(ObjectInputStream s) >> ^ >> ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:43: >> warning: no comment >> private final String file; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:44: >> warning: no comment >> private final String other; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:43: >> warning: no comment >> private int index; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:42: >> warning: no comment >> private String input; >>^ >> ./open/src/java.base/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java:43: >> warning: no comment >> private final String name; >> ^ >> Changes to >> [`genExceptions.sh`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) >> and the two >> [`exceptions`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) >> templates are to address the warnings concerned with >> `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java` >> which are generated when `make jdk-image` is run. A CSR will be filed in due >> course with respect to these changes. > > Conor Cleary has updated the pull request incrementally with one additional > commit since the last revision: > > 8264779: Simplified comments src/java.base/share/classes/java/nio/charset/MalformedInputException.java line 45: > 43: > 44: /** > 45: * The length of the input byte sequence. Should this comment also refer to the character sequence? src/java.base/share/classes/java/nio/charset/exceptions line 31: > 29: PACKAGE=java.nio.charset > 30: # This year should only change if the generated source is modified. > 31: COPYRIGHT_YEARS="2000, 2021," Do those modifications to the exception sources end up in a change in `generated` sources? src/java.base/share/classes/java/nio/exceptions line 31: > 29: PACKAGE=java.nio > 30: # This year should only change if the generated source is modified. > 31: COPYRIGHT_YEARS="2000, 2021," Does not seem necessary, as I don't see any changes in java.nio package. - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
On Wed, 7 Apr 2021 14:40:48 GMT, Conor Cleary wrote: >> This fix addresses the following warnings which were generated by building >> JDK API documentation with the `-Xdoclint:all` option enabled: >> >> ./build/linux-x64/support/gensrc/java.base/java/nio/charset/IllegalCharsetNameException.java:47: >> warning: no comment >> private String charsetName; >>^ >> ./open/src/java.base/share/classes/java/nio/charset/MalformedInputException.java:44: >> warning: no comment >> private int inputLength; >> ^ >> ./open/src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java:44: >> warning: no comment >> private int inputLength; >> ^ >> ./build/linux-x64/support/gensrc/java.base/java/nio/charset/UnsupportedCharsetException.java:47: >> warning: no comment >> private String charsetName; >>^ >> ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: >> warning: no @param for s >> private void readObject(ObjectInputStream s) >> ^ >> ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: >> warning: no @throws for java.lang.ClassNotFoundException >> private void readObject(ObjectInputStream s) >> ^ >> ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:43: >> warning: no comment >> private final String file; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:44: >> warning: no comment >> private final String other; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:43: >> warning: no comment >> private int index; >> ^ >> ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:42: >> warning: no comment >> private String input; >>^ >> ./open/src/java.base/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java:43: >> warning: no comment >> private final String name; >> ^ >> Changes to >> [`genExceptions.sh`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) >> and the two >> [`exceptions`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) >> templates are to address the warnings concerned with >> `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java` >> which are generated when `make jdk-image` is run. A CSR will be filed in due >> course with respect to these changes. > > Conor Cleary has updated the pull request incrementally with one additional > commit since the last revision: > > 8264779: Simplified comments Marked as reviewed by iris (Reviewer). - PR: https://git.openjdk.java.net/jdk/pull/3376
Re: RFR: 8264779: Fix doclint warnings in java/nio [v2]
> This fix addresses the following warnings which were generated by building > JDK API documentation with the `-Xdoclint:all` option enabled: > > ./build/linux-x64/support/gensrc/java.base/java/nio/charset/IllegalCharsetNameException.java:47: > warning: no comment > private String charsetName; >^ > ./open/src/java.base/share/classes/java/nio/charset/MalformedInputException.java:44: > warning: no comment > private int inputLength; > ^ > ./open/src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java:44: > warning: no comment > private int inputLength; > ^ > ./build/linux-x64/support/gensrc/java.base/java/nio/charset/UnsupportedCharsetException.java:47: > warning: no comment > private String charsetName; >^ > ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: > warning: no @param for s > private void readObject(ObjectInputStream s) > ^ > ./open/src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java:81: > warning: no @throws for java.lang.ClassNotFoundException > private void readObject(ObjectInputStream s) > ^ > ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:43: > warning: no comment > private final String file; > ^ > ./open/src/java.base/share/classes/java/nio/file/FileSystemException.java:44: > warning: no comment > private final String other; > ^ > ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:43: > warning: no comment > private int index; > ^ > ./open/src/java.base/share/classes/java/nio/file/InvalidPathException.java:42: > warning: no comment > private String input; >^ > ./open/src/java.base/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java:43: > warning: no comment > private final String name; > ^ > Changes to > [`genExceptions.sh`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) > and the two > [`exceptions`](https://github.com/openjdk/jdk/commit/b729d8ed7970737a8a2d4e8aa788df33789faea2) > templates are to address the warnings concerned with > `UnsupportedCharsetException.java` and `IllegalCharsetNameException.java` > which are generated when `make jdk-image` is run. A CSR will be filed in due > course with respect to these changes. Conor Cleary has updated the pull request incrementally with one additional commit since the last revision: 8264779: Simplified comments - Changes: - all: https://git.openjdk.java.net/jdk/pull/3376/files - new: https://git.openjdk.java.net/jdk/pull/3376/files/b729d8ed..0b879f15 Webrevs: - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=3376&range=01 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=3376&range=00-01 Stats: 2 lines in 2 files changed: 0 ins; 0 del; 2 mod Patch: https://git.openjdk.java.net/jdk/pull/3376.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/3376/head:pull/3376 PR: https://git.openjdk.java.net/jdk/pull/3376
