RFR: 8251551: Use .md filename extension for README

Erik Helin erik.helin at oracle.com
Sat Aug 15 09:52:01 UTC 2020


On 8/14/20 8:07 PM, mark.reinhold at oracle.com wrote:
> 2020/8/14 4:57:18 -0700, erik.helin at oracle.com:
>> On 8/14/20 11:43 AM, Magnus Ihse Bursie wrote:
>>> When I wrote the original README, the only use-case I had in mind was
>>> for someone to have checked out the code locally, not someone seeing it
>>> as a project description on Github. So I'd suggest a change more along
>>> these lines:
>>> ---
>>> For build instructions, please see the [online
>>> documentation](https://openjdk.java.net/groups/build/doc/building.html),
>>> or either of these files:
>>>
>>> - [doc/building.html](doc/building.html) (html version)
>>> - [doc/building.md](doc/building.md) (markdown version)
>>> ---
>>
>> Thanks for reviewing Magnus! I agree with your suggestion, please see
>> updated webrevs below:
>>
>> - full: https://cr.openjdk.java.net/~ehelin/8251551/01/
>> - incremental: https://cr.openjdk.java.net/~ehelin/8251551/00-01/
>>
>> You can also see a rendered version of the README.md file in my personal
>> fork [0].
> 
> There’s an extra comma in there.
> 
> s/For build instructions, please/For build instructions please see/

Thanks for reviewing Mark and for catching the extra comma! Please see 
updated webrevs below:

- full: https://cr.openjdk.java.net/~ehelin/8251551/02/
- incremental: https://cr.openjdk.java.net/~ehelin/8251551/01-02/

On 8/14/20 8:07 PM, mark.reinhold at oracle.com wrote:
> Otherwise, looks good.

Thanks!
Erik

> - Mark


More information about the jdk-dev mailing list