iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

befs: add kernel-doc formatting for befs_bt_read_super()

Browse Source 
fs/befs/TODO mentions some comments needing conversion to Kernel-Doc
formatting. This patch changes the comment describing befs_bt_read_super().

Signed-off-by: Tommy Nguyen <remyabel@gmail.com>
Signed-off-by: Luis de Bethencourt <luisbg@kernel.org>
This commit is contained in:
Tommy Nguyen 2017-07-09 10:25:43 +01:00 committed by Luis de Bethencourt
parent 6f7da29041
commit 799ce1dbb9
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
fs/befs/btree.c
View File

@ -120,18 +120,15 @@ static int befs_compare_strings(const void *key1, int keylen1,
const void *key2, int keylen2); const void *key2, int keylen2);
/** /**
* befs_bt_read_super - read in btree superblock convert to cpu byteorder * befs_bt_read_super() - read in btree superblock convert to cpu byteorder
* @sb: Filesystem superblock * @sb: Filesystem superblock
* @ds: Datastream to read from * @ds: Datastream to read from
* @sup: Buffer in which to place the btree superblock * @sup: Buffer in which to place the btree superblock
* *
* Calls befs_read_datastream to read in the btree superblock and * Calls befs_read_datastream to read in the btree superblock and
* makes sure it is in cpu byteorder, byteswapping if necessary. * makes sure it is in cpu byteorder, byteswapping if necessary.
* * Return: BEFS_OK on success and if *@sup contains the btree superblock in cpu
* On success, returns BEFS_OK and *@sup contains the btree superblock, * byte order. Otherwise return BEFS_ERR on error.
* in cpu byte order.
*
* On failure, BEFS_ERR is returned.
*/ */
static int static int
befs_bt_read_super(struct super_block *sb, const befs_data_stream *ds, befs_bt_read_super(struct super_block *sb, const befs_data_stream *ds,