Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754211AbdFWKsZ (ORCPT ); Fri, 23 Jun 2017 06:48:25 -0400 Received: from mail-yb0-f193.google.com ([209.85.213.193]:34173 "EHLO mail-yb0-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751153AbdFWKsY (ORCPT ); Fri, 23 Jun 2017 06:48:24 -0400 Date: Fri, 23 Jun 2017 06:48:22 -0400 From: Tommy Nguyen To: Luis de Bethencourt Cc: Salah Triki , linux-kernel@vger.kernel.org Subject: [PATCH] fs: befs: btree: Add Kernel-Doc formatting for befs_bt_read_super() Message-ID: <20170623104822.GA26076@NoChina> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.8.0 (2017-02-23) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1439 Lines: 39 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 --- fs/befs/btree.c | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/fs/befs/btree.c b/fs/befs/btree.c index d509887..5ef2b83 100644 --- a/fs/befs/btree.c +++ b/fs/befs/btree.c @@ -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, -- 2.9.4