Re: [PATCH 2/8] docs: tweak kernel-doc for QEMU coding standards

[Paolo Bonzini]

On 02/12/19 19:01, Peter Maydell wrote:
>> +       if (/\s*([\w\s]+?)(\s*-|:)/) {
>>             $identifier = $1;
>>         }
>>
>> @@ -1888,7 +1896,7 @@ sub process_name($$) {
>>         $contents = "";
>>         $section = $section_default;
>>         $new_start_line = $. + 1;
>> -       if (/-(.*)/) {
>> +       if (/[-:](.*)/) {
>>             # strip leading/trailing/multiple spaces
>>             $descr= $1;
>>             $descr =~ s/^\s*//;
> These two bits seem to be a third thing not mentioned
> in the commit message -- permitting either colon or
> hyphen in the "Thing: short description" introductory line,
> where kernel style insists on a hyphen.
> 
> (You could make the argument that this is an unnecessary
> drift from the kernel-doc style and we should just fix
> up all those colons...)

Perhaps we could yeah.  Problem is, there are just three hyphens (one in
include/hw/stream.h, two in include/qemu/host-utils.h) so that would be
quite a big patch.  We could do that as we add kernel-doc directive, if
you prefer that, or do it in one shot after committing this series, or
just live with the two lines changed above.

Paolo