On 2/26/26 4:56 PM, Jakub Kicinski wrote:
> On Thu, 26 Feb 2026 14:10:54 -0800 Randy Dunlap wrote:
>> +    /* private: */
>>      OVS_DP_ATTR_UNSPEC,
>> +    /* public: */
> 
> Hm, can't quickly grep the relevant guidance but I always thought that

I don't think there is any relevant guidance unless you consider an example
in Documentation/doc-guide/kernel-doc.rst to be guidance, where the example
does agree with your comment.

But kernel-doc doesn't have any _requirement_ that these comments begin
in column 1.

> the comment is supposed to pretend to be a label. IOW not be indented:
> 
>  enum ovs_datapath_attr {
>  /* private: */
>       OVS_DP_ATTR_UNSPEC,
>  /* public: */
>       OVS_DP_ATTR_NAME,               /* name of dp_ifindex netdev */
> 
> I find that easier to read, but no strong preference.

-- 
~Randy

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to