RFR [12] - 8211960: broken links in java.util.logging
Hi, Please find below a doc-only fix for: 8211960: broken links in java.util.logging https://bugs.openjdk.java.net/browse/JDK-8211960 webrev: http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.00/index.html The original link was intended to refer to java.util.Formatter#syntax, which is in another module (and no longer in the parent directory). Rather than try to navigate the class/module hierarchy to link to that same anchor, this patch proposes to link to String#format instead, which has all the appropriate information and which is what the implementation is specified to use anyway. best regards, -- daniel
On 10/10/18 11:39, Daniel Fuchs wrote:
Hi,
Please find below a doc-only fix for:
8211960: broken links in java.util.logging https://bugs.openjdk.java.net/browse/JDK-8211960
webrev: http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.00/index.html
Looks good. -Chris.
On 10/10/18 3:39 AM, Daniel Fuchs wrote:
Hi,
Please find below a doc-only fix for:
8211960: broken links in java.util.logging https://bugs.openjdk.java.net/browse/JDK-8211960
webrev: http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.00/index.html
Alternatively, this can link to java.util.Formatter class as the text is "format string". It seems that Formatter class fits better with the SimpleFormatter class description than String.format. Mandy
Hi Mandy, On 10/10/2018 16:32, Mandy Chung wrote:
On 10/10/18 3:39 AM, Daniel Fuchs wrote:
Hi,
Please find below a doc-only fix for:
8211960: broken links in java.util.logging https://bugs.openjdk.java.net/browse/JDK-8211960
webrev: http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.00/index.html
Alternatively, this can link to java.util.Formatter class as the text is "format string". It seems that Formatter class fits better with the SimpleFormatter class description than String.format.
Right - I was afraid of possible confusion between java.util.logging.Formatter and java.util.Formatter, and the spec shows a call to String.format(....) when explaining how the LogRecord is formatted... But if you still think that {@linkplain java.util.Formatter format string} is a better link - let me know - I'll make the change. best regards, -- daniel
Mandy
On 10/10/18 8:44 AM, Daniel Fuchs wrote:
Hi Mandy,
On 10/10/2018 16:32, Mandy Chung wrote:
Alternatively, this can link to java.util.Formatter class as the text is "format string". It seems that Formatter class fits better with the SimpleFormatter class description than String.format.
Right - I was afraid of possible confusion between java.util.logging.Formatter and java.util.Formatter, and the spec shows a call to String.format(....) when explaining how the LogRecord is formatted...
But if you still think that {@linkplain java.util.Formatter format string} is a better link - let me know - I'll make the change.
The javadoc of SimpleFormatter::format(LogRecord) method does describe the format argument is a java.util.Formatter format string. Also the class description also links to this method. So I think these two broken links can simply be removed and the spec about the formatting is in the SimpleFormatter::format method javadoc. What do you think? Mandy
Hi Mandy, On 10/10/2018 17:56, Mandy Chung wrote:
The javadoc of SimpleFormatter::format(LogRecord) method does describe the format argument is a java.util.Formatter format string. Also the class description also links to this method. So I think these two broken links can simply be removed and the spec about the formatting is in the SimpleFormatter::format method javadoc. What do you think?
I agree, this is probably the better solution: http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.01/index.html best regards, -- daniel On 10/10/18 3:39 AM, Daniel Fuchs wrote:
8211960: broken links in java.util.logging https://bugs.openjdk.java.net/browse/JDK-8211960
webrev: http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.00/index.html
On 10/11/18 4:54 AM, Daniel Fuchs wrote:
Hi Mandy,
On 10/10/2018 17:56, Mandy Chung wrote:
The javadoc of SimpleFormatter::format(LogRecord) method does describe the format argument is a java.util.Formatter format string. Also the class description also links to this method. So I think these two broken links can simply be removed and the spec about the formatting is in the SimpleFormatter::format method javadoc. What do you think?
I agree, this is probably the better solution:
http://cr.openjdk.java.net/~dfuchs/webrev_8211960/webrev.01/index.html
Looks good. + * @see #format(LogRecord) This might not be needed since it's linked from {@linkplain #format(LogRecord) format} the log messages. No need for a new webrev. Thanks Mandy
participants (3)
-
Chris Hegarty
-
Daniel Fuchs
-
Mandy Chung