From patchwork Mon Mar 19 00:36:29 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Lyle X-Patchwork-Id: 10291485 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id DC4CA600F6 for ; Mon, 19 Mar 2018 00:37:11 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id CE2DE28D4B for ; Mon, 19 Mar 2018 00:37:11 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id C2FE128F56; Mon, 19 Mar 2018 00:37:11 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 4903928D4B for ; Mon, 19 Mar 2018 00:37:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754856AbeCSAhK (ORCPT ); Sun, 18 Mar 2018 20:37:10 -0400 Received: from mail-pg0-f68.google.com ([74.125.83.68]:46695 "EHLO mail-pg0-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754685AbeCSAhA (ORCPT ); Sun, 18 Mar 2018 20:37:00 -0400 Received: by mail-pg0-f68.google.com with SMTP id g8so3147503pgq.13 for ; Sun, 18 Mar 2018 17:37:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lyle-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=9FH4o1gwUwwQwpO7sNwBCmIxyls25oqB35MlwpGjcIA=; b=Rb/1cFf2VKO7DOrqZjkSpJeLfdbHWeTMgNEQrLn/yOyqBJmtu4lW/YtiSozPFVqHLl aGCMNVzo/p4IpgCV2fpvdvX2Sxt5YJjmNwcy9X3WL5Y0D08tQbFxqMB3iXaFg+rQ2YZ+ nqyn9+PsRwQyity5OZXrIgbWRqCVdtwpPjlB+sSgaMJOfmXtHnag1T6HsVvvdreI816E XlkY70K47xP/+rq1D0hFqBwPTD8XqUIPFWoMwWbW4HJzJg7Jmt47YC2thQs8Hc+lKP+G ZOsEDIwgjrpG9q5VfE0g2tfdRZ/Ex5uJmXXR6nYrKjUJzzZ3Ljr3JMlH1IVWIyOkGi83 887g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=9FH4o1gwUwwQwpO7sNwBCmIxyls25oqB35MlwpGjcIA=; b=ugdWXttPG7g03wDs66a2QRpkc6vEIMC5bu9GlC+tomnamDPbzKDND0i8HN4fXaTCCK ui/HbJJ+DxGeFqZNde0WF+b/hWrvsj0OagDIW729DZK+lzPGcuVuTWKqAcw0cKKKyf39 YCk/jiBDPp+yJmzThO33n1i4IQ7RA1iH5gxUKAf21T6HsW3w8FEL2ffNxQfCRezp8JBS jU3c46mIWtiArZHEaIeGiwjXzTF0cmTkuf9yeJ9tYW/8T9VDjiOrW5E9L5xHrru/17Gn nv3QHC/J8nFajiF8lVO7UNWGljc4+0dPdXnsD565J89T6lCTtcA9Dc1lEauoOXA/DOcL Tulg== X-Gm-Message-State: AElRT7HQLPfTPaCdwiQvOipJ7qFI+izcuLxfCSGlERcDqxlZuoSpFWbh eaE9lBS5kioKxf4RsLO+pXcVWg== X-Google-Smtp-Source: AG47ELsMk/UyG4YeGSYR1D+Ma9eIRi2E8dq6OdpLKyxPTCDwAs90ZPqTyXkHRgtsJv6q168hbld4bg== X-Received: by 10.98.54.65 with SMTP id d62mr5899635pfa.52.1521419819630; Sun, 18 Mar 2018 17:36:59 -0700 (PDT) Received: from midnight.lan (2600-6c52-6200-09b7-0000-0000-0000-0d66.dhcp6.chtrptr.net. [2600:6c52:6200:9b7::d66]) by smtp.gmail.com with ESMTPSA id a17sm27674857pfc.122.2018.03.18.17.36.58 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sun, 18 Mar 2018 17:36:59 -0700 (PDT) From: Michael Lyle To: linux-bcache@vger.kernel.org, linux-block@vger.kernel.org Cc: axboe@fb.com, Bart Van Assche Subject: [for-4.17 16/20] bcache: Fix kernel-doc warnings Date: Sun, 18 Mar 2018 17:36:29 -0700 Message-Id: <20180319003633.27225-17-mlyle@lyle.org> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180319003633.27225-1-mlyle@lyle.org> References: <20180319003633.27225-1-mlyle@lyle.org> Sender: linux-block-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-block@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Bart Van Assche Avoid that building with W=1 triggers warnings about the kernel-doc headers. Signed-off-by: Bart Van Assche Reviewed-by: Michael Lyle --- drivers/md/bcache/btree.c | 2 +- drivers/md/bcache/closure.c | 8 ++++---- drivers/md/bcache/request.c | 1 + drivers/md/bcache/util.c | 18 ++++++++---------- 4 files changed, 14 insertions(+), 15 deletions(-) diff --git a/drivers/md/bcache/btree.c b/drivers/md/bcache/btree.c index 143ed5a758e7..17936b2dc7d6 100644 --- a/drivers/md/bcache/btree.c +++ b/drivers/md/bcache/btree.c @@ -962,7 +962,7 @@ static struct btree *mca_alloc(struct cache_set *c, struct btree_op *op, return b; } -/** +/* * bch_btree_node_get - find a btree node in the cache and lock it, reading it * in from disk if necessary. * diff --git a/drivers/md/bcache/closure.c b/drivers/md/bcache/closure.c index c0949c9f843b..0e14969182c6 100644 --- a/drivers/md/bcache/closure.c +++ b/drivers/md/bcache/closure.c @@ -46,7 +46,7 @@ void closure_sub(struct closure *cl, int v) } EXPORT_SYMBOL(closure_sub); -/** +/* * closure_put - decrement a closure's refcount */ void closure_put(struct closure *cl) @@ -55,7 +55,7 @@ void closure_put(struct closure *cl) } EXPORT_SYMBOL(closure_put); -/** +/* * closure_wake_up - wake up all closures on a wait list, without memory barrier */ void __closure_wake_up(struct closure_waitlist *wait_list) @@ -79,9 +79,9 @@ EXPORT_SYMBOL(__closure_wake_up); /** * closure_wait - add a closure to a waitlist - * - * @waitlist will own a ref on @cl, which will be released when + * @waitlist: will own a ref on @cl, which will be released when * closure_wake_up() is called on @waitlist. + * @cl: closure pointer. * */ bool closure_wait(struct closure_waitlist *waitlist, struct closure *cl) diff --git a/drivers/md/bcache/request.c b/drivers/md/bcache/request.c index 5a82237c7025..a65e3365eeb9 100644 --- a/drivers/md/bcache/request.c +++ b/drivers/md/bcache/request.c @@ -296,6 +296,7 @@ static void bch_data_insert_start(struct closure *cl) /** * bch_data_insert - stick some data in the cache + * @cl: closure pointer. * * This is the starting point for any data to end up in a cache device; it could * be from a normal write, or a writeback write, or a write to a flash only diff --git a/drivers/md/bcache/util.c b/drivers/md/bcache/util.c index 6198041f0ee2..74febd5230df 100644 --- a/drivers/md/bcache/util.c +++ b/drivers/md/bcache/util.c @@ -82,10 +82,9 @@ STRTO_H(strtoll, long long) STRTO_H(strtoull, unsigned long long) /** - * bch_hprint() - formats @v to human readable string for sysfs. - * - * @v - signed 64 bit integer - * @buf - the (at least 8 byte) buffer to format the result into. + * bch_hprint - formats @v to human readable string for sysfs. + * @buf: the (at least 8 byte) buffer to format the result into. + * @v: signed 64 bit integer * * Returns the number of bytes used by format. */ @@ -225,13 +224,12 @@ void bch_time_stats_update(struct time_stats *stats, uint64_t start_time) } /** - * bch_next_delay() - increment @d by the amount of work done, and return how - * long to delay until the next time to do some work. + * bch_next_delay() - update ratelimiting statistics and calculate next delay + * @d: the struct bch_ratelimit to update + * @done: the amount of work done, in arbitrary units * - * @d - the struct bch_ratelimit to update - * @done - the amount of work done, in arbitrary units - * - * Returns the amount of time to delay by, in jiffies + * Increment @d by the amount of work done, and return how long to delay in + * jiffies until the next time to do some work. */ uint64_t bch_next_delay(struct bch_ratelimit *d, uint64_t done) {