RFR: JDK-8320458: Improve structural navigation in API documentation [v2]

Hannes Wallnöfer hannesw at openjdk.org
Thu Jan 11 14:48:26 UTC 2024


On Tue, 9 Jan 2024 23:07:17 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Update src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java
>>   
>>   Co-authored-by: Andrey Turbanov <turbanoff at gmail.com>
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/script.js.template line 1:
> 
>> 1: /*
> 
> I note that at least in part this is a rename of `script.js` (and rightly so) that Git has failed to detect (grrr.) Others may want to use external tools to compare the old and new forms. The differences are primarily a significant expansion of these lines in the old code:
> 
> 
> // Dynamically set scroll margin to accomodate for draft header
> document.addEventListener("DOMContentLoaded", function(e) {
>     document.querySelectorAll(':not(input)[id]').forEach(
>         function(c) {
>             c.style["scroll-margin-top"] = Math.ceil(document.querySelector("header").offsetHeight) + "px"
>         });
> });

Right. I wondered if I had done anything wrong when renaming the file, but it seems `git` always handles renames as remove-add, and the only way to influence rename detection is in `git diff`. I guess I could have prevented this by renaming and adding/updating in two different commits, which I will do in the future.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/17062#discussion_r1448971042


More information about the build-dev mailing list