Skip to contentSkip to conversation

fs: befs: btree: Add Kernel-Doc formatting for befs_bt_read_super()

PATCH In review Tommy Nguyen 2 participants 2 messages Jun 23, 2017 Befs file system

lore
Share & tools
lore

Tommy Nguyen

author
#0 lore raw

PATCH 1/1 fs: befs: btree: 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 <[email protected]>
---
 fs/befs/btree.c | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)
fs/befs/btree.c +6 -8
index d509887..5ef2b83 100644
@@ -120,18 +120,16 @@ 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,
Signature · 1 line
2.9.4
#1 lore raw
Quoted 5 lines · Tommy Nguyen

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 <[email protected]>

---

Hello Tommy,

This looks great, thank you very much.

Sorry for the inconvenience, but do you mind re-sending this with [email protected] in the CC? My @osg.samsung.com address is going to stop existing in a few hours and I won't have access to your patch.

Will merge this over the weekend.

Thanks,
Luis