Re: RFR: JDK-8263468: New page for "recent" new API [v2]
On Mon, 7 Jun 2021 14:53:55 GMT, Jonathan Gibbons wrote:
>> Hannes Wallnöfer has updated the pull request incrementally with one
>> additional commit since the last revision:
>>
>> JDK-8263468: automate build integration
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
> line 268:
>
>> 266: doclet.help.new.body=\
>> 267: The {0} page lists APIs that have been added in recent releases. \
>> 268: The content of this page is based on information provided by
>> Javadoc @since tags.
>
> Either change to "JavaDoc" or (preferably?) just delete this word, or even
> the sentence.
>
> Is there any interaction with `-nosince`? Should there be?
I removed the second sentence.
There is no interaction with `-nosince`. I one point I thought `-nosince`
should disable this feature, but actually both features are just different ways
of displaying the information stored in `@since` tags that don't depend on each
other.
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Extern.java
> line 337:
>
>> 335: */
>> 336: public int getSourceVersionNumber() {
>> 337: return configuration.docEnv.getSourceVersion().ordinal();
>
> As a general comment, I believe Joe does not encourage use of `ordinal`
I undid this change as it's not really part of the feature.
-
PR: https://git.openjdk.java.net/jdk/pull/4209
Re: RFR: JDK-8263468: New page for "recent" new API [v2]
On Mon, 7 Jun 2021 14:52:57 GMT, Jonathan Gibbons wrote: >> Hannes Wallnöfer has updated the pull request incrementally with one >> additional commit since the last revision: >> >> JDK-8263468: automate build integration > > src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties > line 112: > >> 110: doclet.Deprecated_Tabs_Intro=(The leftmost tab "Deprecated ..." >> indicates all the \ >> 111: deprecated elements, regardless of the releases in which they were >> deprecated. \ >> 112: Each of the righthand tabs "Deprecated in ..." indicates the >> elements deprecated \ > > "Each of the righthand" doesn't read well. Would "Each of the other" be > better? Changed to "Each of the other". - PR: https://git.openjdk.java.net/jdk/pull/4209
Re: RFR: JDK-8263468: New page for "recent" new API [v2]
On Fri, 28 May 2021 08:19:33 GMT, Hannes Wallnöfer wrote:
>> This adds a new kind of summary list for new API added in specific releases,
>> and adds information to the deprecated API list about elements that were
>> deprecated in the given releases.
>>
>> The changes to the code are relatively minor thanks to the existing
>> infrastructure for summary list pages, which was extended by adding the
>> `getTableCaption` and `addTableTabs` methods to `SummaryListWriter.java` in
>> order to generate tabbed tables.
>>
>> One important area that needs to be reviewed is the addition of resources in
>> `standard.properties`. A relatively big share of discussion and effort went
>> into shaping the UI messages.
>>
>> The build system change adds options to generate API changes for all
>> releases after JDK 11, with "New API since JDK 11" as page title for the new
>> API page. I uploaded the generated documentation here:
>>
>> http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/new-list.html
>> http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/deprecated-list.html
>
> Hannes Wallnöfer has updated the pull request incrementally with one
> additional commit since the last revision:
>
> JDK-8263468: automate build integration
Some minor suggestions for your consideration
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
line 112:
> 110: doclet.Deprecated_Tabs_Intro=(The leftmost tab "Deprecated ..."
> indicates all the \
> 111: deprecated elements, regardless of the releases in which they were
> deprecated. \
> 112: Each of the righthand tabs "Deprecated in ..." indicates the
> elements deprecated \
"Each of the righthand" doesn't read well. Would "Each of the other" be
better?
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
line 119:
> 117: doclet.New_Label=New
> 118: doclet.New_Tabs_Intro=(The leftmost tab "New ..." indicates all the new
> elements, \
> 119: regardless of the releases in which they were added. Each of the
> righthand \
ditto
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
line 268:
> 266: doclet.help.new.body=\
> 267: The {0} page lists APIs that have been added in recent releases. \
> 268: The content of this page is based on information provided by Javadoc
> @since tags.
Either change to "JavaDoc" or (preferably?) just delete this word, or even the
sentence.
Is there any interaction with `-nosince`? Should there be?
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Extern.java
line 337:
> 335: */
> 336: public int getSourceVersionNumber() {
> 337: return configuration.docEnv.getSourceVersion().ordinal();
As a general comment, I believe Joe does not encourage use of `ordinal`
-
PR: https://git.openjdk.java.net/jdk/pull/4209
Re: RFR: JDK-8263468: New page for "recent" new API [v2]
On Fri, 28 May 2021 08:19:33 GMT, Hannes Wallnöfer wrote: >> This adds a new kind of summary list for new API added in specific releases, >> and adds information to the deprecated API list about elements that were >> deprecated in the given releases. >> >> The changes to the code are relatively minor thanks to the existing >> infrastructure for summary list pages, which was extended by adding the >> `getTableCaption` and `addTableTabs` methods to `SummaryListWriter.java` in >> order to generate tabbed tables. >> >> One important area that needs to be reviewed is the addition of resources in >> `standard.properties`. A relatively big share of discussion and effort went >> into shaping the UI messages. >> >> The build system change adds options to generate API changes for all >> releases after JDK 11, with "New API since JDK 11" as page title for the new >> API page. I uploaded the generated documentation here: >> >> http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/new-list.html >> http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/deprecated-list.html > > Hannes Wallnöfer has updated the pull request incrementally with one > additional commit since the last revision: > > JDK-8263468: automate build integration Build changes look great! - Marked as reviewed by erikj (Reviewer). PR: https://git.openjdk.java.net/jdk/pull/4209
Re: RFR: JDK-8263468: New page for "recent" new API [v2]
On Thu, 27 May 2021 13:32:36 GMT, Erik Joelsson wrote: >> Yes, there are a few things, but in the build itself, we are down to a >> single config file today, so I would really appreciate if this could be >> figured out. I can provide the implementation for generating this, but I >> need to understand what the expected pattern is. From what I can see, it >> looks like $(sequence N, M) where N is the last LTS+1 and M is current JDK >> version. Then the string has "JDK N" in it. M is already well defined, so >> the only new input here is N, which we could move to the version numbers >> config file (make/conf/version-numbers.conf). Something like >> DEFAULT_VERSION_DOCS_API_SINCE=11. There is some additional boilerplate >> needed, and the sequence macro of course, but does this sound reasonable to >> you? > > We actually have a sequence macro already, so generating the list can be done > like this: > > $(call CommaList,$(call sequence 12, 17)) > > Or if what you have is 11 and 17: > > $(call CommaList, $(filter-out 11, $(call sequence 11, 17))) Thanks for the help and for providing all the pieces, Erik! I just added a new commit and I think I got everything working. - PR: https://git.openjdk.java.net/jdk/pull/4209
Re: RFR: JDK-8263468: New page for "recent" new API [v2]
> This adds a new kind of summary list for new API added in specific releases, > and adds information to the deprecated API list about elements that were > deprecated in the given releases. > > The changes to the code are relatively minor thanks to the existing > infrastructure for summary list pages, which was extended by adding the > `getTableCaption` and `addTableTabs` methods to `SummaryListWriter.java` in > order to generate tabbed tables. > > One important area that needs to be reviewed is the addition of resources in > `standard.properties`. A relatively big share of discussion and effort went > into shaping the UI messages. > > The build system change adds options to generate API changes for all releases > after JDK 11, with "New API since JDK 11" as page title for the new API page. > I uploaded the generated documentation here: > > http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/new-list.html > http://cr.openjdk.java.net/~hannesw/8263468/api-pr.00/deprecated-list.html Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision: JDK-8263468: automate build integration - Changes: - all: https://git.openjdk.java.net/jdk/pull/4209/files - new: https://git.openjdk.java.net/jdk/pull/4209/files/e81532b2..2a9dbbbf Webrevs: - full: https://webrevs.openjdk.java.net/?repo=jdk=4209=01 - incr: https://webrevs.openjdk.java.net/?repo=jdk=4209=00-01 Stats: 10 lines in 4 files changed: 9 ins; 0 del; 1 mod Patch: https://git.openjdk.java.net/jdk/pull/4209.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/4209/head:pull/4209 PR: https://git.openjdk.java.net/jdk/pull/4209
