On Mon, 11 Jun 2018 15:17:16 +0100 Peter Maydell <peter.mayd...@linaro.org> wrote:
> The codebase has a bit of a mix of different multiline > comment styles. State a preference for the Linux kernel > style: > /* > * Star on the left for each line. > * Leading slash-star and trailing star-slash > * each go on a line of their own. > */ > > Signed-off-by: Peter Maydell <peter.mayd...@linaro.org> > --- > This is not my personal favourite, but seemed to be the > closest we had to consensus in the mail thread for v1; > I can live with it in order to avoid getting patches which > use the styles I like even less :-) > --- > CODING_STYLE | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > > diff --git a/CODING_STYLE b/CODING_STYLE > index 12ba58ee293..2d84f5f26d1 100644 > --- a/CODING_STYLE > +++ b/CODING_STYLE > @@ -124,6 +124,23 @@ We use traditional C-style /* */ comments and avoid // > comments. > Rationale: The // form is valid in C99, so this is purely a matter of > consistency of style. The checkpatch script will warn you about this. > > +Multiline comments blocks should have a row of stars on the left, > +and the initial /* and terminating */ both on their own lines: > + /* > + * like > + * this > + */ > +This is the same format required by the Linux kernel coding style. > + > +(Some of the existing comments in the codebase use the GNU Coding > +Standards form which does not have stars on the left, or other > +variations; avoid these when writing new comments, but don't worry > +about converting to the preferred form unless you're editing that > +comment anyway.) > + > +Rationale: Consistency, and ease of visually picking out a multiline > +comment from the surrounding code. > + > 8. trace-events style > > 8.1 0x prefix Much preferred, thanks (tabs next? ;) Reviewed-by: Alex Williamson <alex.william...@redhat.com>
