[VDO-5704] Ingest doc typo fixes

drivers/md/dm-vdo/admin-state.c

@@ -300,7 +300,7 @@ static bool check_code(bool valid, const struct admin_state_code *code, const ch
 }
 
 /**
- * vdo_drain_operation() - Check that an operation is a drain.
+ * assert_vdo_drain_operation() - Check that an operation is a drain.
  * @waiter The completion to finish with an error if the operation is not a drain.
  *
  * Return: true if the specified operation is a drain.

drivers/md/dm-vdo/dedupe.c

@@ -2839,7 +2839,7 @@ static const char *index_state_to_string(struct hash_zones *zones,
 }
 
 /**
- * vdo_dump_hash_zone() - Dump information about a hash zone to the log for debugging.
+ * dump_hash_zone() - Dump information about a hash zone to the log for debugging.
  * @zone: The zone to dump.
  */
 static void dump_hash_zone(const struct hash_zone *zone)

drivers/md/dm-vdo/dm-vdo-target.c

@@ -2907,17 +2907,15 @@ static int __init vdo_init(void)
 {
 	int result = 0;
 
-	/*
-	 * UDS module level initialization must be done first, as VDO initialization depends on it
-	 */
+	/* Memory tracking must be initialized first for accurate accounting. */
 	uds_memory_init();
 	uds_init_sysfs();
 
 	vdo_initialize_thread_device_registry();
 	vdo_initialize_device_registry_once();
 	uds_log_info("loaded version %s", CURRENT_VERSION);
 
-	/* Add VDO errors to the already existing set of errors in UDS. */
+	/* Add VDO errors to the set of errors registered by the indexer. */
 	result = vdo_register_status_codes();
 	if (result != UDS_SUCCESS) {
 		uds_log_error("vdo_register_status_codes failed %d", result);
@@ -2939,11 +2937,8 @@ static int __init vdo_init(void)
 static void __exit vdo_exit(void)
 {
 	vdo_module_destroy();
-	/*
-	 * UDS module level exit processing must be done after all VDO module exit processing is
-	 * complete.
-	 */
 	uds_put_sysfs();
+	/* Memory tracking cleanup must be done last. */
 	uds_memory_exit();
 }
 

drivers/md/dm-vdo/encodings.c

@@ -1172,7 +1172,7 @@ static struct vdo_component unpack_vdo_component_41_0(struct packed_vdo_componen
 }
 
 /**
- * vdo_decode_component() - Decode the component data for the vdo itself out of the super block.
+ * decode_vdo_component() - Decode the component data for the vdo itself out of the super block.
  *
  * Return: VDO_SUCCESS or an error.
  */

drivers/md/dm-vdo/flush.c

@@ -88,7 +88,7 @@ static inline struct vdo_flush *completion_as_vdo_flush(struct vdo_completion *c
 }
 
 /**
- * waiter_as_flush() - Convert a vdo_flush's generic wait queue entry back to the vdo_flush.
+ * vdo_waiter_as_flush() - Convert a vdo_flush's generic wait queue entry back to the vdo_flush.
  * @waiter: The wait queue entry to convert.
  *
  * Return: The wait queue entry as a vdo_flush.

drivers/md/dm-vdo/indexer/delta-index.c

@@ -35,7 +35,7 @@
  *
  * Each delta list is stored as a bit stream. Within the delta list encoding, bits and bytes are
  * numbered in little endian order. Within a byte, bit 0 is the least significant bit (0x1), and
- * bit 7 is the most significant bit (0x80). Within a bit stream, bit 7 is the most signficant bit
+ * bit 7 is the most significant bit (0x80). Within a bit stream, bit 7 is the most significant bit
  * of byte 0, and bit 8 is the least significant bit of byte 1. Within a byte array, a byte's
  * number corresponds to its index in the array.
  *

drivers/md/dm-vdo/indexer/delta-index.h

@@ -141,7 +141,7 @@ struct delta_index_page {
  *     record at the end of the list.
  *
  * (5) If at_end is false and is_collision is true, the delta_list entry fields refer to a
- *     collision entry in the list, and the delta_list entry can be used a a reference to this
+ *     collision entry in the list, and the delta_list entry can be used as a reference to this
  *     entry.
  *
  * (6) If at_end is false and is_collision is false, the delta_list entry fields refer to a

drivers/md/dm-vdo/logical-zone.c

@@ -295,8 +295,8 @@ static void notify_flusher(struct vdo_completion *completion)
 }
 
 /**
- * void attempt_generation_complete_notification() - Notify the flusher if some generation no
- *                                                   longer has active VIOs.
+ * attempt_generation_complete_notification() - Notify the flusher if some generation no
+ *                                              longer has active VIOs.
  * @completion: The zone completion.
  */
 static void attempt_generation_complete_notification(struct vdo_completion *completion)

drivers/md/dm-vdo/physical-zone.c

@@ -258,7 +258,7 @@ static int make_pbn_lock_pool(size_t capacity, struct pbn_lock_pool **pool_ptr)
 }
 
 /**
- * vdo_free_pbn_lock_pool() - Free a PBN lock pool.
+ * free_pbn_lock_pool() - Free a PBN lock pool.
  * @pool: The lock pool to free.
  *
  * This also frees all the PBN locks it allocated, so the caller must ensure that all locks have

drivers/md/dm-vdo/slab-depot.c

@@ -2035,8 +2035,8 @@ static inline slab_block_number find_zero_byte_in_word(const u8 *word_ptr,
 }
 
 /**
- * vdo_find_free_block() - Find the first block with a reference count of zero in the specified
- *                         range of reference counter indexes.
+ * find_free_block() - Find the first block with a reference count of zero in the specified
+ *                     range of reference counter indexes.
  * @slab: The slab counters to scan.
  * @index_ptr: A pointer to hold the array index of the free block.
  *
@@ -5032,7 +5032,7 @@ get_ref_counts_statistics(const struct slab_depot *depot)
 }
 
 /**
- * get_depot_slab_journal_statistics() - Get the aggregated slab journal statistics for the depot.
+ * get_slab_journal_statistics() - Get the aggregated slab journal statistics for the depot.
  * @depot: The slab depot.
  *
  * Return: The aggregated statistics for all slab journals in the depot.

drivers/md/dm-vdo/vdo.c

@@ -67,10 +67,7 @@ struct sync_completion {
 	struct completion completion;
 };
 
-/*
- * We don't expect this set to ever get really large, so a linked list is adequate. We can use a
- * pointer_map if we need to later.
- */
+/* A linked list is adequate for the small number of entries we expect. */
 struct device_registry {
 	struct list_head links;
 	/* TODO: Convert to rcu per kernel recommendation. */
@@ -267,8 +264,8 @@ static int __must_check initialize_thread_config(struct thread_count_config coun
 }
 
 /**
- * vdo_read_geometry_block() - Synchronously read the geometry block from a vdo's underlying block
- *                             device.
+ * read_geometry_block() - Synchronously read the geometry block from a vdo's underlying block
+ *                         device.
  * @vdo: The vdo whose geometry is to be read.
  *
  * Return: VDO_SUCCESS or an error code.