RFR: 8273497: Building.md should link to testing md file rather than html

Aleksey Shipilev shade at openjdk.java.net
Thu Sep 9 10:26:59 UTC 2021


On Wed, 8 Sep 2021 17:40:50 GMT, Dan Heidinga <github.com+8503711+DanHeidinga at openjdk.org> wrote:

> > (2) looks appealing for me, for a different reason: if you regenerate `.md` -> `.html`, and choose the unexpected pandoc version (for example one provided by distro), then `.html` diff would have a lot of fluff not related to the actual change. And that would keep happening as people regenerate `.html` with their own versions of pandocs :) Removing `.html` from repo resolves this problem at its core.
> 
> It still leaves the original question though - should the `.md` file link to the `.html` or the `.md` version? My preference is the `.md` file as markdown is more readable, IMO, for both offline and github viewing.

Yes, it does leave the original question unanswered, apologies.

I would suggest to change all `.html` -> `.md` links in the PR that removes `.html` completely. It would be a larger PR and would probably require some buy-ins, but I think those are relatively simple. Removing HTMLs would not introduce any ambiguity with these link rewrites.

At the same time, I have no problems with this tiny PR as well.

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

PR: https://git.openjdk.java.net/jdk/pull/5417



More information about the build-dev mailing list