Comment formatting

2,518 views
Skip to first unread message

Patrick Tsai

unread,
Nov 10, 2011, 7:58:42 AM11/10/11
to Repo and Gerrit Discussion
It seems that I can wrote the following Markdown-similar syntax in
comment:

- Foo
- Bar

Gerrit will show my comment in HTML list. My question is where I can
find detailed description of comment formatting syntax?

Thanks in advance.

Shawn Pearce

unread,
Nov 14, 2011, 11:30:25 AM11/14/11
to Patrick Tsai, Repo and Gerrit Discussion

I don't think it has been documented. The general gist is, blank line
separates paragraphs. When a paragraph's lines all start with "-" or
"*" in the first character on each line, the line is formatted as a
list. When a paragraph's lines all start with leading spaces, the
paragraph is formatted "as-is" using an HTML <pre> style. This is
mostly useful for code samples.

The best way to experiment with the formatting is in an inline draft
comment. Type your text on a comment for a line of a file somewhere,
and save the draft, you will see how it is formatted. If you don't
like your comment, you can edit or discard it.

Reply all
Reply to author
Forward
0 new messages