linux-kernel - Re: [PATCH] ubi: ubi.h: fix kernel-doc warnings

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] [day] [month] [year] [list]

Message-ID: <32bed230-4089-92e5-da7a-19741153d19f@huawei.com>
Date: Fri, 30 Jan 2026 09:12:19 +0800
From: Zhihao Cheng <chengzhihao1@...wei.com>
To: Randy Dunlap <rdunlap@...radead.org>, <linux-kernel@...r.kernel.org>
CC: Richard Weinberger <richard@....at>, Miquel Raynal
	<miquel.raynal@...tlin.com>, Vignesh Raghavendra <vigneshr@...com>,
	<linux-mtd@...ts.infradead.org>
Subject: Re: [PATCH] ubi: ubi.h: fix kernel-doc warnings

在 2026/1/28 14:24, Randy Dunlap 写道:
> Fix all default warning level kernel-doc warnings in ubi.h:
> 
> Warning: drivers/mtd/ubi/ubi.h:176 struct member 'u' not described in 'ubi_wl_entry'
> Warning: drivers/mtd/ubi/ubi.h:370 struct member 'is_dead' not described in 'ubi_volume'
> Warning: drivers/mtd/ubi/ubi.h:655 struct member 'is_dead' not described in 'ubi_device'
> Warning: drivers/mtd/ubi/ubi.h:743 bad line: all existing Fastmap data structures
> Warning: drivers/mtd/ubi/ubi.h:783 struct member 'vidb' not described in 'ubi_attach_info'
> Warning: drivers/mtd/ubi/ubi.h:1098 expecting prototype for ubi_init_vid_buf().
>   Prototype was for ubi_alloc_vid_buf() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> Cc: Richard Weinberger <richard@....at>
> Cc: Zhihao Cheng <chengzhihao1@...wei.com>
> Cc: Miquel Raynal <miquel.raynal@...tlin.com>
> Cc: Vignesh Raghavendra <vigneshr@...com>
> Cc: linux-mtd@...ts.infradead.org
> 
>   drivers/mtd/ubi/ubi.h |    9 ++++++---
>   1 file changed, 6 insertions(+), 3 deletions(-)

Reviewed-by: Zhihao Cheng <chengzhihao1@...wei.com>
> 
> --- linux-next-20260126.orig/drivers/mtd/ubi/ubi.h
> +++ linux-next-20260126/drivers/mtd/ubi/ubi.h
> @@ -160,6 +160,7 @@ struct ubi_vid_io_buf {
>    * struct ubi_wl_entry - wear-leveling entry.
>    * @u.rb: link in the corresponding (free/used) RB-tree
>    * @u.list: link in the protection queue
> + * @u: union of rb_node and list_head
>    * @ec: erase counter
>    * @pnum: physical eraseblock number
>    *
> @@ -282,6 +283,7 @@ struct ubi_eba_leb_desc {
>    * @writers: number of users holding this volume in read-write mode
>    * @exclusive: whether somebody holds this volume in exclusive mode
>    * @metaonly: whether somebody is altering only meta data of this volume
> + * @is_dead: prevents taking a reference to the volume
>    *
>    * @reserved_pebs: how many physical eraseblocks are reserved for this volume
>    * @vol_type: volume type (%UBI_DYNAMIC_VOLUME or %UBI_STATIC_VOLUME)
> @@ -449,6 +451,7 @@ struct ubi_debug_info {
>    *                @vol->eba_tbl.
>    * @ref_count: count of references on the UBI device
>    * @image_seq: image sequence number recorded on EC headers
> + * @is_dead: prevents taking a reference to the volume
>    *
>    * @rsvd_pebs: count of reserved physical eraseblocks
>    * @avail_pebs: count of available physical eraseblocks
> @@ -741,7 +744,7 @@ struct ubi_ainf_volume {
>    * @highest_vol_id: highest volume ID
>    * @is_empty: flag indicating whether the MTD device is empty or not
>    * @force_full_scan: flag indicating whether we need to do a full scan and drop
> -		     all existing Fastmap data structures
> + *		     all existing Fastmap data structures
>    * @min_ec: lowest erase counter value
>    * @max_ec: highest erase counter value
>    * @max_sqnum: highest sequence number value
> @@ -750,7 +753,7 @@ struct ubi_ainf_volume {
>    * @ec_count: a temporary variable used when calculating @mean_ec
>    * @aeb_slab_cache: slab cache for &struct ubi_ainf_peb objects
>    * @ech: temporary EC header. Only available during scan
> - * @vidh: temporary VID buffer. Only available during scan
> + * @vidb: temporary VID buffer. Only available during scan
>    *
>    * This data structure contains the result of attaching an MTD device and may
>    * be used by other UBI sub-systems to build final UBI data structures, further
> @@ -1090,7 +1093,7 @@ static inline void ubi_init_vid_buf(cons
>   }
>   
>   /**
> - * ubi_init_vid_buf - Allocate a VID buffer
> + * ubi_alloc_vid_buf - Allocate a VID buffer
>    * @ubi: the UBI device
>    * @gfp_flags: GFP flags to use for the allocation
>    */
> .
>