path: root/fs/nilfs2/alloc.h
diff options
authorRyusuke Konishi <konishi.ryusuke@lab.ntt.co.jp>2010-04-12 01:46:02 +0900
committerRyusuke Konishi <konishi.ryusuke@lab.ntt.co.jp>2010-05-10 11:32:31 +0900
commitdb55d92252c07c0e5561966ecca95c6f332dd892 (patch)
tree624aacfce2e287a89f4a49f03b543af3b5e4a6da /fs/nilfs2/alloc.h
parentfdce895ea5dd4e24edf1f4d693827349a4e5b3b4 (diff)
nilfs2: add kernel doc comments to persistent object allocator functions
The implementation of persistent object allocator (alloc.c) is poorly documented. This adds kernel doc style comments on that functions. Signed-off-by: Ryusuke Konishi <konishi.ryusuke@lab.ntt.co.jp>
Diffstat (limited to 'fs/nilfs2/alloc.h')
1 files changed, 7 insertions, 0 deletions
diff --git a/fs/nilfs2/alloc.h b/fs/nilfs2/alloc.h
index 5cccf874d692..9af34a7e6e13 100644
--- a/fs/nilfs2/alloc.h
+++ b/fs/nilfs2/alloc.h
@@ -29,6 +29,13 @@
#include <linux/buffer_head.h>
#include <linux/fs.h>
+ * nilfs_palloc_entries_per_group - get the number of entries per group
+ * @inode: inode of metadata file using this allocator
+ *
+ * The number of entries per group is defined by the number of bits
+ * that a bitmap block can maintain.
+ */
static inline unsigned long
nilfs_palloc_entries_per_group(const struct inode *inode)