RFR: Extend documentation regarding logging [v2]

David Holmes dholmes at openjdk.org
Wed Sep 21 02:07:59 UTC 2022


On Tue, 13 Sep 2022 08:27:07 GMT, Johan Sjölen <jsjolen at openjdk.org> wrote:

>> src/guide/hotspot-development.md line 14:
>> 
>>> 12: 
>>> 13: The appropriate way to print logging output from HotSpot is through the [Unified Logging Framework (JEP 158)](https://openjdk.org/jeps/158).
>>> 14: It gives you a lot of nice features and enables common command-line options for all logging.
>> 
>> Please don't add line breaks in sections. Goes for sections below as well.
>
> I did it to increase readability while editing, and I didn't see a difference when reading the rendered product. Feels like there's some reasoning I'm missing here.

Starting each sentence on a new line seems a very personal style choice - ref:
https://groups.google.com/g/pandoc-discuss/c/tEWDWL2mLBY?pli=1
It probably helps if also trying to maintain maximum line lengths, as editing may need fewer lines to be rewrapped. But personally I find it jarring to read.

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

PR: https://git.openjdk.org/guide/pull/91


More information about the guide-dev mailing list