Documentation Source Text

Help: comment-format
Login

The "comment-format" setting:

Set the algorithm for printing timeline comments to the console.

Possible values are:

1
Use the original comment printing algorithm:
  • Leading and trialing whitespace is removed
  • Internal whitespace is converted into a single space (0x20)
  • Line breaks occurs at whitespace or hyphens if possible
This is the recommended value and the default.

Or a bitwise combination of the following flags:

2
Trim leading and trailing CR and LF characters.
4
Trim leading and trailing white space characters.
8
Attempt to break lines on word boundaries.
16
Break lines before the original comment embedded in other text.

Note: To preserve line breaks and/or other whitespace within comment text, make this setting some integer value that omits the "1" bit.