Commit 19ac19e0 authored by Matthew Sakai's avatar Matthew Sakai Committed by Mikulas Patocka
Browse files

dm vdo: fix function doc comment formatting

parent 7e976b2b
Loading
Loading
Loading
Loading
+0 −2
Original line number Diff line number Diff line
@@ -209,8 +209,6 @@ static int initialize_info(struct vdo_page_cache *cache)
/**
 * allocate_cache_components() - Allocate components of the cache which require their own
 *                               allocation.
 * @maximum_age: The number of journal blocks before a dirtied page is considered old and must be
 *               written out.
 *
 * The caller is responsible for all clean up on errors.
 *
+4 −3
Original line number Diff line number Diff line
@@ -327,8 +327,9 @@ static u32 __must_check pack_status(struct data_vio_compression_status status)

/**
 * set_data_vio_compression_status() - Set the compression status of a data_vio.
 * @state: The expected current status of the data_vio.
 * @new_state: The status to set.
 * @data_vio: The data_vio to change.
 * @status: The expected current status of the data_vio.
 * @new_status: The status to set.
 *
 * Return: true if the new status was set, false if the data_vio's compression status did not
 *         match the expected state, and so was left unchanged.
@@ -836,7 +837,7 @@ static void destroy_data_vio(struct data_vio *data_vio)
 * @vdo: The vdo to which the pool will belong.
 * @pool_size: The number of data_vios in the pool.
 * @discard_limit: The maximum number of data_vios which may be used for discards.
 * @pool: A pointer to hold the newly allocated pool.
 * @pool_ptr: A pointer to hold the newly allocated pool.
 */
int make_data_vio_pool(struct vdo *vdo, data_vio_count_t pool_size,
		       data_vio_count_t discard_limit, struct data_vio_pool **pool_ptr)
+5 −4
Original line number Diff line number Diff line
@@ -565,7 +565,7 @@ static void wait_on_hash_lock(struct hash_lock *lock, struct data_vio *data_vio)
 * @waiter: The data_vio's waiter link.
 * @context: Not used.
 */
static void abort_waiter(struct vdo_waiter *waiter, void *context __always_unused)
static void abort_waiter(struct vdo_waiter *waiter, void __always_unused *context)
{
	write_data_vio(vdo_waiter_as_data_vio(waiter));
}
@@ -1727,7 +1727,7 @@ static void report_bogus_lock_state(struct hash_lock *lock, struct data_vio *dat
/**
 * vdo_continue_hash_lock() - Continue the processing state after writing, compressing, or
 *                            deduplicating.
 * @data_vio: The data_vio to continue processing in its hash lock.
 * @completion: The data_vio completion to continue processing in its hash lock.
 *
 * Asynchronously continue processing a data_vio in its hash lock after it has finished writing,
 * compressing, or deduplicating, so it can share the result with any data_vios waiting in the hash
@@ -1825,7 +1825,7 @@ static inline int assert_hash_lock_preconditions(const struct data_vio *data_vio

/**
 * vdo_acquire_hash_lock() - Acquire or share a lock on a record name.
 * @data_vio: The data_vio acquiring a lock on its record name.
 * @completion: The data_vio completion acquiring a lock on its record name.
 *
 * Acquire or share a lock on the hash (record name) of the data in a data_vio, updating the
 * data_vio to reference the lock. This must only be called in the correct thread for the zone. In
@@ -2679,7 +2679,8 @@ static void get_index_statistics(struct hash_zones *zones,

/**
 * vdo_get_dedupe_statistics() - Tally the statistics from all the hash zones and the UDS index.
 * @hash_zones: The hash zones to query
 * @zones: The hash zones to query
 * @stats: A structure to store the statistics
 *
 * Return: The sum of the hash lock statistics from all hash zones plus the statistics from the UDS
 *         index
+1 −1
Original line number Diff line number Diff line
@@ -858,7 +858,7 @@ static int __must_check make_partition(struct layout *layout, enum partition_id
/**
 * vdo_initialize_layout() - Lay out the partitions of a vdo.
 * @size: The entire size of the vdo.
 * @origin: The start of the layout on the underlying storage in blocks.
 * @offset: The start of the layout on the underlying storage in blocks.
 * @block_map_blocks: The size of the block map partition.
 * @journal_blocks: The size of the journal partition.
 * @summary_blocks: The size of the slab summary partition.
+1 −1
Original line number Diff line number Diff line
@@ -367,7 +367,7 @@ void __submit_metadata_vio(struct vio *vio, physical_block_number_t physical,
 *                     completions.
 * @max_requests_active: Number of bios for merge tracking.
 * @vdo: The vdo which will use this submitter.
 * @io_submitter: pointer to the new data structure.
 * @io_submitter_ptr: pointer to the new data structure.
 *
 * Return: VDO_SUCCESS or an error.
 */
Loading