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

From: Jakub Kicinski <kuba@kernel.org>
To: menglong8.dong@gmail.com
Cc: rostedt@goodmis.org, mingo@redhat.com, davem@davemloft.net,
	edumazet@google.com, pabeni@redhat.com, nhorman@tuxdriver.com,
	ast@kernel.org, daniel@iogearbox.net, andrii@kernel.org,
	kafai@fb.com, songliubraving@fb.com, yhs@fb.com,
	john.fastabend@gmail.com, kpsingh@kernel.org,
	imagedong@tencent.com, dsahern@kernel.org, talalahmad@google.com,
	keescook@chromium.org, linux-kernel@vger.kernel.org,
	netdev@vger.kernel.org, bpf@vger.kernel.org
Subject: Re: [PATCH net-next 3/3] net: dropreason: reformat the comment fo skb drop reasons
Date: Fri, 27 May 2022 18:19:15 -0700	[thread overview]
Message-ID: <20220527181915.6e776577@kernel.org> (raw)
In-Reply-To: <20220527071522.116422-4-imagedong@tencent.com>

On Fri, 27 May 2022 15:15:22 +0800 menglong8.dong@gmail.com wrote:
> From: Menglong Dong <imagedong@tencent.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@tencent.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,
...