Re: [PATCH] Add documentation for Enum value 'NR_DAMON_OPS' in enum 'damon_ops_id'

Re: [PATCH] Add documentation for Enum value 'NR_DAMON_OPS' in enum 'damon_ops_id'

[SeongJae Park]

Hi Gautam,


Thank you for the patch.  'checkpatch.pl' complains as below, though:

	WARNING: Possible unwrapped commit description (prefer a maximum 75 chars per line)
	#12:
	Fix the warning - "Enum value 'NR_DAMON_OPS' not described in enum 'damon_ops_id'" generated by the command "make pdfdocs"

	WARNING: From:/Signed-off-by: email address mismatch: 'From: Gautam Menghani <gautammenghani14@gmail.com>' != 'Signed-off-by: Gautam Menghani <gautammenghani201@gmail.com>'

	total: 0 errors, 2 warnings, 7 lines checked

Could you please fix those?

On Sat, 7 May 2022 12:38:50 +0530 Gautam Menghani <gautammenghani201@gmail.com> wrote:

> From: Gautam Menghani <gautammenghani14@gmail.com>
> 
> Fix the warning - "Enum value 'NR_DAMON_OPS' not described in enum 'damon_ops_id'" generated by the command "make pdfdocs"
> 
> Signed-off-by: Gautam Menghani <gautammenghani201@gmail.com>
> ---
>  include/linux/damon.h | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/include/linux/damon.h b/include/linux/damon.h
> index f23cbfa4248d..b972a7a3b6f0 100644
> --- a/include/linux/damon.h
> +++ b/include/linux/damon.h
> @@ -262,6 +262,7 @@ struct damos {
>   *
>   * @DAMON_OPS_VADDR:	Monitoring operations for virtual address spaces
>   * @DAMON_OPS_PADDR:	Monitoring operations for the physical address space
> + * @NR_DAMON_OPS:	Number of monitoring operations for a particular implementation

I'd like to keep the 80 column limit[1].

[1] https://docs.kernel.org/process/coding-style.html#breaking-long-lines-and-strings

Also, strictly speaking, it's not the number of monitoring operations for _a
particular implementation_, but 'number of monitoring operations
implementations'.  And it's shorter.  How about the suggestion?


Thanks,
SJ

>   */
>  enum damon_ops_id {
>  	DAMON_OPS_VADDR,
> -- 
> 2.25.1