rhashtable: headers: add missing members, remove excess ones
Subsystems (2)
PATCH 1/1 rhashtable: headers: add missing members, remove excess ones
Add or remove kernel-doc comments for missing or excess struct members and function (or macro) parameters to prevent these kernel-doc warnings:
Warning: include/linux/rhashtable-types.h:108 struct member 'alloc_tag' not described in 'rhashtable'
Warning: include/linux/rhashtable-types.h:108 struct member 'lockdep_key' not described in 'rhashtable'
Warning: include/linux/rhashtable-types.h:145 struct member 'end_of_table' not described in 'rhashtable_iter'
Warning: include/linux/rhashtable-types.h:199 Excess function parameter 'ht' description in 'rhashtable_init'
Warning: include/linux/rhashtable-types.h:199 Excess function parameter 'params' description in 'rhashtable_init'
Warning: include/linux/rhashtable-types.h:220 Excess function parameter 'hlt' description in 'rhltable_init'
Warning: include/linux/rhashtable-types.h:220 Excess function parameter 'params' description in 'rhltable_init'
Warning: include/linux/rhashtable.h:87 struct member 'dep_map' not described in 'bucket_table'
Warning: include/linux/rhashtable.h:87 Excess struct member 'rehash' description in 'bucket_table'
Warning: include/linux/rhashtable.h:87 Excess struct member 'ntbl' description in 'bucket_table'
---
Cc: Thomas Graf <[email protected]>
Cc: Herbert Xu <[email protected]>
Cc: [email protected]
include/linux/rhashtable-types.h | 11 +++++++---- include/linux/rhashtable.h | 3 +-- 2 files changed, 8 insertions(+), 6 deletions(-)
include/linux/rhashtable.h +1 -2
@@ -65,12 +65,11 @@ struct rhash_lock_head {};* struct bucket_table - Table of hash buckets * @size: Number of hash buckets * @nest: Number of bits of first-level nested table. -* @rehash: Current bucket being rehashed * @hash_rnd: Random seed to fold into hash * @walkers: List of active walkers * @rcu: RCU structure for freeing the table * @future_tbl: Table under construction during rehashing -* @ntbl: Nested table used when out of memory. +* @dep_map: Lockdep tracking map * @buckets: size * hash buckets */ struct bucket_table {
include/linux/rhashtable-types.h +7 -4
@@ -88,6 +88,8 @@ struct rhashtable_lockdep_keys {* @mutex: Mutex to protect current/future table swapping * @lock: Spin lock to protect walker list * @nelems: Number of elements in table +* @alloc_tag: Allocation codetag and percpu counters +* @lockdep_key: Lockdep keys for each lock */ struct rhashtable {struct bucket_table __rcu *tbl;
@@ -134,6 +136,7 @@ struct rhashtable_walker {* @walker: Associated rhashtable walker * @slot: Current slot * @skip: Number of entries to skip in slot +* @end_of_table: End of table walk has been reached */ struct rhashtable_iter {struct rhashtable *ht;
@@ -157,8 +160,8 @@ int __rhashtable_init_noprof(struct rhas/** * rhashtable_init - initialize a new hash table -* @ht: hash table to be initialized -* @params: configuration parameters +* @...: variable args list: hash table to be initialized and +* configuration parameters * * Initializes a new hash table based on the provided configuration * parameters. A table can be configured either with a variable or
@@ -211,8 +214,8 @@ int __rhltable_init_noprof(struct rhltab/** * rhltable_init - initialize a new hash list table -* @hlt: hash list table to be initialized -* @params: configuration parameters +* @...: variable args list: hash list table to be initialized and +* configuration parameters * * Initializes a new hash list table. *