@@ -1512,8 +1512,7 @@ int btrfs_find_all_roots(struct btrfs_trans_handle *trans,
}
/**
- * Check if an extent is shared or not
- *
+ * btrfs_check_shared - Check if an extent is shared or not
* @root: root inode belongs to
* @inum: inode number of the inode whose extent we are checking
* @bytenr: logical bytenr of the extent we are checking
@@ -1746,8 +1746,7 @@ static void set_avail_alloc_bits(struct btrfs_fs_info *fs_info, u64 flags)
}
/**
- * Map a physical disk address to a list of logical addresses
- *
+ * btrfs_rmap_block - Map a physical disk address to a list of logical addresses
* @fs_info: the filesystem
* @chunk_start: logical address of block group
* @bdev: physical device to resolve, can be NULL to indicate any device
@@ -2305,8 +2305,7 @@ int btrfs_search_backwards(struct btrfs_root *root, struct btrfs_key *key,
}
/**
- * Search for a valid slot for the given path.
- *
+ * btrfs_get_next_valid_item - Search for a valid slot for the given path.
* @root: The root node of the tree.
* @key: Will contain a valid item if found.
* @path: The starting point to validate the slot.
@@ -193,7 +193,7 @@ void btrfs_free_reserved_data_space(struct btrfs_inode *inode,
btrfs_qgroup_free_data(inode, reserved, start, len);
}
-/**
+/*
* Release any excessive reservation
*
* @inode: the inode we need to release from
@@ -369,8 +369,7 @@ int btrfs_delalloc_reserve_metadata(struct btrfs_inode *inode, u64 num_bytes,
}
/**
- * Release a metadata reservation for an inode
- *
+ * btrfs_delalloc_release_metadata - Release a metadata reservation for an inode
* @inode: the inode to release the reservation for.
* @num_bytes: the number of bytes we are releasing.
* @qgroup_free: free qgroup reservation or convert it to per-trans reservation
@@ -467,7 +466,7 @@ int btrfs_delalloc_reserve_space(struct btrfs_inode *inode,
}
/**
- * Release data and metadata space for delalloc
+ * btrfs_delalloc_release_space - Release data and metadata space for delalloc
*
* @inode: inode we're releasing space for
* @reserved: list of changed/reserved ranges
@@ -70,8 +70,7 @@ int btrfs_should_throttle_delayed_refs(struct btrfs_trans_handle *trans)
}
/**
- * Release a ref head's reservation
- *
+ * btrfs_delayed_refs_rsv_release - Release a ref head's reservation
* @fs_info: the filesystem
* @nr: number of items to drop
*
@@ -138,8 +137,7 @@ void btrfs_update_delayed_refs_rsv(struct btrfs_trans_handle *trans)
}
/**
- * Transfer bytes to our delayed refs rsv
- *
+ * btrfs_migrate_to_delayed_refs_rsv - Transfer bytes to our delayed refs rsv
* @fs_info: the filesystem
* @src: source block rsv to transfer from
* @num_bytes: number of bytes to transfer
@@ -187,8 +185,7 @@ void btrfs_migrate_to_delayed_refs_rsv(struct btrfs_fs_info *fs_info,
}
/**
- * Refill based on our delayed refs usage
- *
+ * btrfs_delayed_refs_rsv_refill - Refill based on our delayed refs usage
* @fs_info: the filesystem
* @flush: control how we can flush for this reservation.
*
@@ -184,7 +184,7 @@ static struct btrfs_block_group *find_next_block_group(
return ret_block_group;
}
-/**
+/*
* Wrap find_next_block_group()
*
* @discard_ctl: discard control
@@ -400,7 +400,7 @@ static struct rb_node *tree_insert(struct rb_root *root,
return NULL;
}
-/**
+/*
* Search @tree for an entry that contains @offset. Such entry would have
* entry->start <= offset && entry->end >= offset.
*
@@ -1600,8 +1600,7 @@ int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
}
/**
- * Find a contiguous area of bits
- *
+ * find_contiguous_extent_bit - Find a contiguous area of bits
* @tree: io tree to check
* @start: offset to start the search from
* @start_ret: the first offset we found with the bits set
@@ -1638,9 +1637,8 @@ int find_contiguous_extent_bit(struct extent_io_tree *tree, u64 start,
}
/**
- * Find the first range that has @bits not set. This range could start before
- * @start.
- *
+ * find_first_clear_extent_bit - Find the first range that has @bits not set.
+ * This range could start before @start.
* @tree: the tree to search
* @start: offset at/after which the found extent should start
* @start_ret: records the beginning of the range
@@ -3137,8 +3135,7 @@ static void end_bio_extent_readpage(struct bio *bio)
}
/**
- * Populate every free slot in a provided array with pages.
- *
+ * btrfs_alloc_page_array - Populate every free slot in a provided array with pages.
* @nr_pages: number of pages to allocate
* @page_array: the array to fill with pages; any existing non-null entries in
* the array will be skipped
@@ -3229,7 +3226,7 @@ struct bio *btrfs_bio_clone_partial(struct bio *orig, u64 offset, u64 size)
return bio;
}
-/**
+/*
* Attempt to add a page to bio
*
* @bio_ctrl: record both the bio, and its bio_flags
@@ -4959,7 +4956,7 @@ int btree_write_cache_pages(struct address_space *mapping,
return ret;
}
-/**
+/*
* Walk the list of dirty pages of the given address space and write all of them.
*
* @mapping: address space structure to write
@@ -7501,7 +7498,7 @@ void btrfs_readahead_tree_block(struct btrfs_fs_info *fs_info,
free_extent_buffer(eb);
}
-/*
+/**
* btrfs_readahead_node_child - readahead a node's child block
* @node: parent node we're reading from
* @slot: slot in the parent node for the child we want to read
@@ -387,8 +387,7 @@ static void extent_map_device_clear_bits(struct extent_map *em, unsigned bits)
}
/**
- * Add new extent map to the extent tree
- *
+ * add_extent_mapping - Add new extent map to the extent tree
* @tree: tree to insert new map in
* @em: map to insert
* @modified: indicate whether the given @em should be added to the
@@ -583,8 +582,7 @@ static noinline int merge_extent_mapping(struct extent_map_tree *em_tree,
}
/**
- * Add extent mapping into em_tree
- *
+ * btrfs_add_extent_mapping - Add extent mapping into em_tree
* @fs_info: the filesystem
* @em_tree: extent tree into which we want to insert the extent mapping
* @em_in: extent we are inserting
@@ -25,8 +25,7 @@
PAGE_SIZE))
/**
- * Set inode's size according to filesystem options
- *
+ * btrfs_inode_safe_disk_i_size_write - Set inode's size according to filesystem options
* @inode: inode we want to update the disk_i_size for
* @new_i_size: i_size we want to set to, 0 if we use i_size
*
@@ -65,8 +64,7 @@ void btrfs_inode_safe_disk_i_size_write(struct btrfs_inode *inode, u64 new_i_siz
}
/**
- * Mark range within a file as having a new extent inserted
- *
+ * btrfs_inode_set_file_extent_range - Mark range within a file as having a new extent inserted
* @inode: inode being modified
* @start: start file offset of the file extent we've inserted
* @len: logical length of the file extent item
@@ -93,8 +91,7 @@ int btrfs_inode_set_file_extent_range(struct btrfs_inode *inode, u64 start,
}
/**
- * Marks an inode range as not having a backing extent
- *
+ * btrfs_inode_clear_file_extent_range - Marks an inode range as not having a backing extent
* @inode: inode being modified
* @start: start file offset of the file extent we've inserted
* @len: logical length of the file extent item
@@ -353,8 +350,7 @@ static int search_file_offset_in_bio(struct bio *bio, struct inode *inode,
}
/**
- * Lookup the checksum for the read bio in csum tree.
- *
+ * btrfs_lookup_bio_sums - Lookup the checksum for the read bio in csum tree.
* @inode: inode that the bio is for.
* @bio: bio to look up.
* @dst: Buffer of size nblocks * btrfs_super_csum_size() used to return
@@ -621,8 +617,7 @@ int btrfs_lookup_csums_range(struct btrfs_root *root, u64 start, u64 end,
}
/**
- * Calculate checksums of the data contained inside a bio
- *
+ * btrfs_csum_one_bio - Calculate checksums of the data contained inside a bio
* @inode: Owner of the data inside the bio
* @bio: Contains the data to be checksummed
* @offset: If (u64)-1, @bio may contain discontiguous bio vecs, so the
@@ -1323,7 +1323,7 @@ int btrfs_wait_cache_io(struct btrfs_trans_handle *trans,
path, block_group->start);
}
-/**
+/*
* Write out cached info to an inode
*
* @root: root the inode belongs to
@@ -3501,7 +3501,7 @@ void btrfs_run_delayed_iputs(struct btrfs_fs_info *fs_info)
}
/**
- * Wait for flushing all delayed iputs
+ * btrfs_wait_on_delayed_iputs - Wait for flushing all delayed iputs
*
* @fs_info: the filesystem
*
@@ -11327,8 +11327,7 @@ void btrfs_update_inode_bytes(struct btrfs_inode *inode,
}
/**
- * Verify that there are no ordered extents for a given file range.
- *
+ * btrfs_assert_inode_range_clean - Verify that there are no ordered extents for a given file range.
* @inode: The target inode.
* @start: Start offset of the file range, should be sector size aligned.
* @end: End offset (inclusive) of the file range, its value +1 should be
@@ -144,8 +144,7 @@ static inline struct rb_node *tree_search(struct btrfs_ordered_inode_tree *tree,
}
/**
- * Add an ordered extent to the per-inode tree.
- *
+ * btrfs_add_ordered_extent - Add an ordered extent to the per-inode tree.
* @inode: Inode that this extent is for.
* @file_offset: Logical offset in file where the extent starts.
* @num_bytes: Logical length of extent in file.
@@ -1378,7 +1378,7 @@ static void wait_reserve_ticket(struct btrfs_fs_info *fs_info,
spin_unlock(&space_info->lock);
}
-/**
+/*
* Do the appropriate flushing and waiting for a ticket
*
* @fs_info: the filesystem
@@ -1471,7 +1471,7 @@ static inline bool can_steal(enum btrfs_reserve_flush_enum flush)
flush == BTRFS_RESERVE_FLUSH_EVICT);
}
-/**
+/*
* Try to reserve bytes from the block_rsv's space
*
* @fs_info: the filesystem
@@ -1598,8 +1598,7 @@ static int __reserve_bytes(struct btrfs_fs_info *fs_info,
}
/**
- * Trye to reserve metadata bytes from the block_rsv's space
- *
+ * btrfs_reserve_metadata_bytes - Try to reserve metadata bytes from the block_rsv's space
* @fs_info: the filesystem
* @block_rsv: block_rsv we're allocating for
* @orig_bytes: number of bytes we want
@@ -1633,7 +1632,7 @@ int btrfs_reserve_metadata_bytes(struct btrfs_fs_info *fs_info,
}
/**
- * Try to reserve data bytes for an allocation
+ * btrfs_reserve_data_bytes - Try to reserve data bytes for an allocation
*
* @fs_info: the filesystem
* @bytes: number of bytes we need
@@ -3040,7 +3040,7 @@ static inline void btrfs_remove_log_ctx(struct btrfs_root *root,
mutex_unlock(&root->log_mutex);
}
-/*
+/*
* Invoked in log mutex context, or be sure there is no other task which
* can access the list.
*/
@@ -6931,8 +6931,7 @@ void btrfs_record_snapshot_destroy(struct btrfs_trans_handle *trans,
}
/**
- * Update the log after adding a new name for an inode.
- *
+ * btrfs_log_new_name - Update the log after adding a new name for an inode.
* @trans: Transaction handle.
* @old_dentry: The dentry associated with the old name and the old
* parent directory.
@@ -534,7 +534,7 @@ btrfs_get_bdev_and_sb(const char *device_path, fmode_t flags, void *holder,
return ret;
}
-/**
+/*
* Search and remove all stale devices (which are not mounted).
* When both inputs are NULL, it will search and release all stale devices.
*
@@ -2316,7 +2316,7 @@ void btrfs_destroy_dev_replace_tgtdev(struct btrfs_device *tgtdev)
}
/**
- * Populate args from device at path
+ * btrfs_get_dev_args_from_path - Populate args from device at path
*
* @fs_info: the filesystem
* @args: the args to populate
@@ -94,7 +94,7 @@ static inline struct workspace *list_to_workspace(struct list_head *list)
void zstd_free_workspace(struct list_head *ws);
struct list_head *zstd_alloc_workspace(unsigned int level);
-/**
+/*
* Timer callback to free unused workspaces.
*
* @t: timer
With some minor adjustments to existing comments fs/btrfs/ is actually W=1 clean. This change involves mainly adding function names in the kernel-doc as well as making some comments not be a kernel-doc (i.e for static functions). Signed-off-by: Nikolay Borisov <nborisov@suse.com> --- fs/btrfs/backref.c | 3 +-- fs/btrfs/block-group.c | 3 +-- fs/btrfs/ctree.c | 3 +-- fs/btrfs/delalloc-space.c | 7 +++---- fs/btrfs/delayed-ref.c | 9 +++------ fs/btrfs/discard.c | 2 +- fs/btrfs/extent_io.c | 19 ++++++++----------- fs/btrfs/extent_map.c | 6 ++---- fs/btrfs/file-item.c | 15 +++++---------- fs/btrfs/free-space-cache.c | 2 +- fs/btrfs/inode.c | 5 ++--- fs/btrfs/ordered-data.c | 3 +-- fs/btrfs/space-info.c | 9 ++++----- fs/btrfs/tree-log.c | 5 ++--- fs/btrfs/volumes.c | 4 ++-- fs/btrfs/zstd.c | 2 +- 16 files changed, 38 insertions(+), 59 deletions(-) -- 2.25.1