diff options
| author | Tommy Nguyen <remyabel@gmail.com> | 2017-07-09 10:25:43 +0100 |
|---|---|---|
| committer | Luis de Bethencourt <luis@debethencourt.com> | 2017-07-09 10:42:50 +0100 |
| commit | 799ce1dbb9bba56ff21733838a05070787fdcde5 (patch) | |
| tree | 28449692eb95a265d1fc762da3b879b532d82605 /fs/befs | |
| parent | 6f7da290413ba713f0cdd9ff1a2a9bb129ef4f6c (diff) | |
befs: add kernel-doc formatting for befs_bt_read_super()
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>
Diffstat (limited to 'fs/befs')
| -rw-r--r-- | fs/befs/btree.c | 15 |
1 files changed, 6 insertions, 9 deletions
diff --git a/fs/befs/btree.c b/fs/befs/btree.c index d509887c580c..1b7e0f7128d6 100644 --- a/fs/befs/btree.c +++ b/fs/befs/btree.c @@ -120,18 +120,15 @@ static int befs_compare_strings(const void *key1, int keylen1, const void *key2, int keylen2); /** - * befs_bt_read_super - read in btree superblock convert to cpu byteorder - * @sb: Filesystem superblock - * @ds: Datastream to read from - * @sup: Buffer in which to place the btree superblock + * befs_bt_read_super() - read in btree superblock convert to cpu byteorder + * @sb: Filesystem superblock + * @ds: Datastream to read from + * @sup: Buffer in which to place the btree superblock * * Calls befs_read_datastream to read in the btree superblock and * makes sure it is in cpu byteorder, byteswapping if necessary. - * - * On success, returns BEFS_OK and *@sup contains the btree superblock, - * in cpu byte order. - * - * On failure, BEFS_ERR is returned. + * Return: BEFS_OK on success and if *@sup contains the btree superblock in cpu + * byte order. Otherwise return BEFS_ERR on error. */ static int befs_bt_read_super(struct super_block *sb, const befs_data_stream *ds, |