qemu-trivial
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Qemu-trivial] [Qemu-devel] [PATCH 0/3] cutils: Cleanup, improve doc


From: Philippe Mathieu-Daudé
Subject: Re: [Qemu-trivial] [Qemu-devel] [PATCH 0/3] cutils: Cleanup, improve documentation
Date: Thu, 3 Jan 2019 10:18:30 +0100

Cc'ing Markus and Thomas who reviewed commit 8c06fbdf36b.

On Thu, Jan 3, 2019 at 10:04 AM Philippe Mathieu-Daudé
<address@hidden> wrote:
> On 1/2/19 6:41 PM, address@hidden wrote:
> > Patchew URL: https://patchew.org/QEMU/address@hidden/
> [...]> === OUTPUT BEGIN ===
> > Checking PATCH 1/3: util/cutils: Move size_to_str() from "qemu-common.h" to 
> > "cutils.h"...
> > WARNING: Block comments use a leading /* on a separate line
> > #42: FILE: include/qemu/cutils.h:160:
> > +/**
>
> I believe this warning is incorrect, since we use the /** marking for
> Doxygen generated documentation. The offending comment is:
>
>   /**
>    * size_to_str:
>    *
>    * Return human readable string for size @val.
>    * Use IEC binary units like KiB, MiB, and so forth.
>    *
>    * @val: The value to format.
>    *       Can be anything that uint64_t allows (no more than "16 EiB").
>    *
>    * Caller is responsible for passing it to g_free().
>    */
>    char *size_to_str(uint64_t val);
>
> Am I missing something?

I had a quick look at scripts/checkpatch.pl:

  # Block comment styles

      # Block comments use /* on a line of its own
      if ($rawline !~ address@hidden/\*.*\*/[ \t]*$@ &&    #inline /*...*/
          $rawline =~ address@hidden/\*\*?[ \t]*.+[ \t]*$@) { # /* or /** 
non-blank
          WARN("Block comments use a leading /* on a separate line\n"
. $herecurr);
      }

I am confused because the comment says it allow blank /**, which is
the case here.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]