[crac] RFR: CRaC related documentation in JDK classes using custom tag [v2]

[Radim Vansa]

On Thu, 13 Apr 2023 16:06:50 GMT, Anton Kozlov <akozlov at openjdk.org> wrote:

>> Radim Vansa has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Add timers related docs
>
> src/java.base/share/classes/java/lang/System.java line 551:
> 
>> 549:      * of expected bounds, or {@link javax.crac.Context#register(javax.crac.Resource) register}
>> 550:      * a resource that will help with adapting after the restore.
>> 551:      *
> 
> The described behavior looks like a bug. After we got to the concensus in #53, this needs to be updated. Or may be just "TODO" here?

Yes, if this gets integrated before #53 I am going to change that one and update the comment with the actual behaviour.

> src/java.base/share/classes/java/lang/System.java line 793:
> 
>> 791:      * a resource and in the {@link javax.crac.Resource#afterRestore(javax.crac.Context) afterRestore method}
>> 792:      * reload system properties, propagating any change.
>> 793:      *
> 
> The comment above is about standard system properties.
> 
> Here we should say that system properties are updated after restore. The app can check the updated value in the afterRestore.

Isn't that exactly what is written in the comment?

> src/java.base/share/classes/java/security/SecureRandom.java line 366:
> 
>> 364:      * the {@link Security#getProviders() Security.getProviders()} method.
>> 365:      *
>> 366:      * @crac See provider documentation for details of behaviour after restore from a checkpoint.
> 
> Shouldn't be a link here?

You mean to the generic provider interface? Here I meant the implementation of the provider.

-------------

PR Review Comment: https://git.openjdk.org/crac/pull/51#discussion_r1170267006
PR Review Comment: https://git.openjdk.org/crac/pull/51#discussion_r1170268773
PR Review Comment: https://git.openjdk.org/crac/pull/51#discussion_r1170273881