linux-kernel - Re: [PATCH net-next 3/3] net: dropreason: reformat the comment fo skb drop reasons

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 27 May 2022 18:19:15 -0700
From:   Jakub Kicinski <kuba@...nel.org>
To:     menglong8.dong@...il.com
Cc:     rostedt@...dmis.org, mingo@...hat.com, davem@...emloft.net,
        edumazet@...gle.com, pabeni@...hat.com, nhorman@...driver.com,
        ast@...nel.org, daniel@...earbox.net, andrii@...nel.org,
        kafai@...com, songliubraving@...com, yhs@...com,
        john.fastabend@...il.com, kpsingh@...nel.org,
        imagedong@...cent.com, dsahern@...nel.org, talalahmad@...gle.com,
        keescook@...omium.org, linux-kernel@...r.kernel.org,
        netdev@...r.kernel.org, bpf@...r.kernel.org
Subject: Re: [PATCH net-next 3/3] net: dropreason: reformat the comment fo
 skb drop reasons

On Fri, 27 May 2022 15:15:22 +0800 menglong8.dong@...il.com wrote:
> From: Menglong Dong <imagedong@...cent.com>
> 
> To make the code clear, reformat the comment in dropreason.h to k-doc
> style.
> 
> Now, the comment can pass the check of kernel-doc without warnning:
> 
> $ ./scripts/kernel-doc -v -none include/linux/dropreason.h
> include/linux/dropreason.h:7: info: Scanning doc for enum skb_drop_reason
> 
> Signed-off-by: Menglong Dong <imagedong@...cent.com>

I feel bad for suggesting this after you reformatted all the values 
but could we use inline notation here? With a huge enum like this
there's a lot of scrolling between documentation and the value.

/**
 * enum skb_drop_reason - the reasons of skb drops
 *
 * The reason of skb drop, which is used in kfree_skb_reason().
 * en...maybe they should be splited by group?
 */
 enum skb_drop_reason {
	/**
	 * @SKB_NOT_DROPPED_YET: skb is not dropped yet (used for no-drop case)
	 */
 	SKB_NOT_DROPPED_YET = 0,
	/** @SKB_DROP_REASON_NOT_SPECIFIED: drop reason is not specified */
	SKB_DROP_REASON_NOT_SPECIFIED,
	/** @SKB_DROP_REASON_NO_SOCKET: socket not found */
	SKB_DROP_REASON_NO_SOCKET,
...