Commit 3bed2da1 authored by Nikolay Borisov's avatar Nikolay Borisov Committed by David Sterba

btrfs: fix parameter description for functions in extent_io.c

This makes the file W=1 clean and fixes the following warnings:

fs/btrfs/extent_io.c:414: warning: Function parameter or member 'tree' not described in '__etree_search'
fs/btrfs/extent_io.c:414: warning: Function parameter or member 'offset' not described in '__etree_search'
fs/btrfs/extent_io.c:414: warning: Function parameter or member 'next_ret' not described in '__etree_search'
fs/btrfs/extent_io.c:414: warning: Function parameter or member 'prev_ret' not described in '__etree_search'
fs/btrfs/extent_io.c:414: warning: Function parameter or member 'p_ret' not described in '__etree_search'
fs/btrfs/extent_io.c:414: warning: Function parameter or member 'parent_ret' not described in '__etree_search'
fs/btrfs/extent_io.c:1607: warning: Function parameter or member 'tree' not described in 'find_contiguous_extent_bit'
fs/btrfs/extent_io.c:1607: warning: Function parameter or member 'start' not described in 'find_contiguous_extent_bit'
fs/btrfs/extent_io.c:1607: warning: Function parameter or member 'start_ret' not described in 'find_contiguous_extent_bit'
fs/btrfs/extent_io.c:1607: warning: Function parameter or member 'end_ret' not described in 'find_contiguous_extent_bit'
fs/btrfs/extent_io.c:1607: warning: Function parameter or member 'bits' not described in 'find_contiguous_extent_bit'
fs/btrfs/extent_io.c:1644: warning: Function parameter or member 'tree' not described in 'find_first_clear_extent_bit'
fs/btrfs/extent_io.c:1644: warning: Function parameter or member 'start' not described in 'find_first_clear_extent_bit'
fs/btrfs/extent_io.c:1644: warning: Function parameter or member 'start_ret' not described in 'find_first_clear_extent_bit'
fs/btrfs/extent_io.c:1644: warning: Function parameter or member 'end_ret' not described in 'find_first_clear_extent_bit'
fs/btrfs/extent_io.c:1644: warning: Function parameter or member 'bits' not described in 'find_first_clear_extent_bit'
fs/btrfs/extent_io.c:4187: warning: Function parameter or member 'epd' not described in 'extent_write_cache_pages'
fs/btrfs/extent_io.c:4187: warning: Excess function parameter 'data' description in 'extent_write_cache_pages'
Signed-off-by: default avatarNikolay Borisov <nborisov@suse.com>
Reviewed-by: default avatarDavid Sterba <dsterba@suse.com>
Signed-off-by: default avatarDavid Sterba <dsterba@suse.com>
parent d98b188e
...@@ -389,16 +389,16 @@ static struct rb_node *tree_insert(struct rb_root *root, ...@@ -389,16 +389,16 @@ static struct rb_node *tree_insert(struct rb_root *root,
} }
/** /**
* __etree_search - searche @tree for an entry that contains @offset. Such * Search @tree for an entry that contains @offset. Such entry would have
* entry would have entry->start <= offset && entry->end >= offset. * entry->start <= offset && entry->end >= offset.
* *
* @tree - the tree to search * @tree: the tree to search
* @offset - offset that should fall within an entry in @tree * @offset: offset that should fall within an entry in @tree
* @next_ret - pointer to the first entry whose range ends after @offset * @next_ret: pointer to the first entry whose range ends after @offset
* @prev - pointer to the first entry whose range begins before @offset * @prev_ret: pointer to the first entry whose range begins before @offset
* @p_ret - pointer where new node should be anchored (used when inserting an * @p_ret: pointer where new node should be anchored (used when inserting an
* entry in the tree) * entry in the tree)
* @parent_ret - points to entry which would have been the parent of the entry, * @parent_ret: points to entry which would have been the parent of the entry,
* containing @offset * containing @offset
* *
* This function returns a pointer to the entry that contains @offset byte * This function returns a pointer to the entry that contains @offset byte
...@@ -1588,12 +1588,13 @@ int find_first_extent_bit(struct extent_io_tree *tree, u64 start, ...@@ -1588,12 +1588,13 @@ int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
} }
/** /**
* find_contiguous_extent_bit: find a contiguous area of bits * Find a contiguous area of bits
* @tree - io tree to check *
* @start - offset to start the search from * @tree: io tree to check
* @start_ret - the first offset we found with the bits set * @start: offset to start the search from
* @end_ret - the final contiguous range of the bits that were set * @start_ret: the first offset we found with the bits set
* @bits - bits to look for * @end_ret: the final contiguous range of the bits that were set
* @bits: bits to look for
* *
* set_extent_bit and clear_extent_bit can temporarily split contiguous ranges * set_extent_bit and clear_extent_bit can temporarily split contiguous ranges
* to set bits appropriately, and then merge them again. During this time it * to set bits appropriately, and then merge them again. During this time it
...@@ -1625,14 +1626,14 @@ int find_contiguous_extent_bit(struct extent_io_tree *tree, u64 start, ...@@ -1625,14 +1626,14 @@ int find_contiguous_extent_bit(struct extent_io_tree *tree, u64 start,
} }
/** /**
* find_first_clear_extent_bit - find the first range that has @bits not set. * Find the first range that has @bits not set. This range could start before
* This range could start before @start. * @start.
* *
* @tree - the tree to search * @tree: the tree to search
* @start - the offset at/after which the found extent should start * @start: offset at/after which the found extent should start
* @start_ret - records the beginning of the range * @start_ret: records the beginning of the range
* @end_ret - records the end of the range (inclusive) * @end_ret: records the end of the range (inclusive)
* @bits - the set of bits which must be unset * @bits: the set of bits which must be unset
* *
* Since unallocated range is also considered one which doesn't have the bits * Since unallocated range is also considered one which doesn't have the bits
* set it's possible that @end_ret contains -1, this happens in case the range * set it's possible that @end_ret contains -1, this happens in case the range
...@@ -4168,10 +4169,11 @@ int btree_write_cache_pages(struct address_space *mapping, ...@@ -4168,10 +4169,11 @@ int btree_write_cache_pages(struct address_space *mapping,
} }
/** /**
* write_cache_pages - walk the list of dirty pages of the given address space and write all of them. * Walk the list of dirty pages of the given address space and write all of them.
*
* @mapping: address space structure to write * @mapping: address space structure to write
* @wbc: subtract the number of written pages from *@wbc->nr_to_write * @wbc: subtract the number of written pages from *@wbc->nr_to_write
* @data: data passed to __extent_writepage function * @epd: holds context for the write, namely the bio
* *
* If a page is already under I/O, write_cache_pages() skips it, even * If a page is already under I/O, write_cache_pages() skips it, even
* if it's dirty. This is desirable behaviour for memory-cleaning writeback, * if it's dirty. This is desirable behaviour for memory-cleaning writeback,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment