Commit a4c18ad2eed93194a667cb9f6662c3b3e8f0bba9
Committed by
Jan Kara
1 parent
bcf3d0bcff
Exists in
master
and in
20 other branches
ext3: Update kernel-doc comments
Update missing/broken argument descriptions and fix formatting. Signed-off-by: Namhyung Kim <namhyung@gmail.com> Signed-off-by: Jan Kara <jack@suse.cz>
Showing 2 changed files with 20 additions and 12 deletions Side-by-side Diff
fs/ext3/balloc.c
... | ... | @@ -810,8 +810,9 @@ |
810 | 810 | |
811 | 811 | /** |
812 | 812 | * claim_block() |
813 | + * @lock: the spin lock for this block group | |
813 | 814 | * @block: the free block (group relative) to allocate |
814 | - * @bh: the bufferhead containts the block group bitmap | |
815 | + * @bh: the buffer_head contains the block group bitmap | |
815 | 816 | * |
816 | 817 | * We think we can allocate this block in this bitmap. Try to set the bit. |
817 | 818 | * If that succeeds then check that nobody has allocated and then freed the |
818 | 819 | |
... | ... | @@ -956,9 +957,11 @@ |
956 | 957 | * but we will shift to the place where start_block is, |
957 | 958 | * then start from there, when looking for a reservable space. |
958 | 959 | * |
959 | - * @size: the target new reservation window size | |
960 | + * @my_rsv: the reservation window | |
960 | 961 | * |
961 | - * @group_first_block: the first block we consider to start | |
962 | + * @sb: the super block | |
963 | + * | |
964 | + * @start_block: the first block we consider to start | |
962 | 965 | * the real search from |
963 | 966 | * |
964 | 967 | * @last_block: |
... | ... | @@ -1084,7 +1087,7 @@ |
1084 | 1087 | * |
1085 | 1088 | * failed: we failed to find a reservation window in this group |
1086 | 1089 | * |
1087 | - * @rsv: the reservation | |
1090 | + * @my_rsv: the reservation window | |
1088 | 1091 | * |
1089 | 1092 | * @grp_goal: The goal (group-relative). It is where the search for a |
1090 | 1093 | * free reservable space should start from. |
1091 | 1094 | |
... | ... | @@ -1273,8 +1276,8 @@ |
1273 | 1276 | * @group: given allocation block group |
1274 | 1277 | * @bitmap_bh: bufferhead holds the block bitmap |
1275 | 1278 | * @grp_goal: given target block within the group |
1276 | - * @count: target number of blocks to allocate | |
1277 | 1279 | * @my_rsv: reservation window |
1280 | + * @count: target number of blocks to allocate | |
1278 | 1281 | * @errp: pointer to store the error code |
1279 | 1282 | * |
1280 | 1283 | * This is the main function used to allocate a new block and its reservation |
fs/ext3/inode.c
... | ... | @@ -498,7 +498,7 @@ |
498 | 498 | } |
499 | 499 | |
500 | 500 | /** |
501 | - * ext3_blks_to_allocate: Look up the block map and count the number | |
501 | + * ext3_blks_to_allocate - Look up the block map and count the number | |
502 | 502 | * of direct blocks need to be allocated for the given branch. |
503 | 503 | * |
504 | 504 | * @branch: chain of indirect blocks |
505 | 505 | |
506 | 506 | |
... | ... | @@ -536,14 +536,18 @@ |
536 | 536 | } |
537 | 537 | |
538 | 538 | /** |
539 | - * ext3_alloc_blocks: multiple allocate blocks needed for a branch | |
539 | + * ext3_alloc_blocks - multiple allocate blocks needed for a branch | |
540 | + * @handle: handle for this transaction | |
541 | + * @inode: owner | |
542 | + * @goal: preferred place for allocation | |
540 | 543 | * @indirect_blks: the number of blocks need to allocate for indirect |
541 | 544 | * blocks |
542 | - * | |
545 | + * @blks: number of blocks need to allocated for direct blocks | |
543 | 546 | * @new_blocks: on return it will store the new block numbers for |
544 | 547 | * the indirect blocks(if needed) and the first direct block, |
545 | - * @blks: on return it will store the total number of allocated | |
546 | - * direct blocks | |
548 | + * @err: here we store the error value | |
549 | + * | |
550 | + * return the number of direct blocks allocated | |
547 | 551 | */ |
548 | 552 | static int ext3_alloc_blocks(handle_t *handle, struct inode *inode, |
549 | 553 | ext3_fsblk_t goal, int indirect_blks, int blks, |
550 | 554 | |
... | ... | @@ -598,9 +602,11 @@ |
598 | 602 | |
599 | 603 | /** |
600 | 604 | * ext3_alloc_branch - allocate and set up a chain of blocks. |
605 | + * @handle: handle for this transaction | |
601 | 606 | * @inode: owner |
602 | 607 | * @indirect_blks: number of allocated indirect blocks |
603 | 608 | * @blks: number of allocated direct blocks |
609 | + * @goal: preferred place for allocation | |
604 | 610 | * @offsets: offsets (in the blocks) to store the pointers to next. |
605 | 611 | * @branch: place to store the chain in. |
606 | 612 | * |
607 | 613 | |
... | ... | @@ -700,10 +706,9 @@ |
700 | 706 | |
701 | 707 | /** |
702 | 708 | * ext3_splice_branch - splice the allocated branch onto inode. |
709 | + * @handle: handle for this transaction | |
703 | 710 | * @inode: owner |
704 | 711 | * @block: (logical) number of block we are adding |
705 | - * @chain: chain of indirect blocks (with a missing link - see | |
706 | - * ext3_alloc_branch) | |
707 | 712 | * @where: location of missing link |
708 | 713 | * @num: number of indirect blocks we are adding |
709 | 714 | * @blks: number of direct blocks we are adding |