From patchwork Fri Mar 12 10:55:23 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 12134297 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1CE99C43332 for ; Fri, 12 Mar 2021 10:56:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id DCE5665014 for ; Fri, 12 Mar 2021 10:56:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233670AbhCLKz6 (ORCPT ); Fri, 12 Mar 2021 05:55:58 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40974 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233672AbhCLKzl (ORCPT ); Fri, 12 Mar 2021 05:55:41 -0500 Received: from mail-wr1-x434.google.com (mail-wr1-x434.google.com [IPv6:2a00:1450:4864:20::434]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 78AE9C061761 for ; Fri, 12 Mar 2021 02:55:40 -0800 (PST) Received: by mail-wr1-x434.google.com with SMTP id k8so1516498wrc.3 for ; Fri, 12 Mar 2021 02:55:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=y2upXzLPWVLGRwG0458fGKMH0wzW7zeYu4SHHuwM9k4=; b=qnmSZDmaTXegmiqZpDi4s1t/1ZjZBLNoJ77NVtDc4tz6lLgtq9aNxhP9OLRGfQX25/ fyPMHBbhR0aQZUhTpjDNfJSyVUG5YPVieXrYdfJt5saetIwsP0jpZWqrox9h7Qx6jdLM KseuLgzmUH4x2OBMgclQp/KtxrKONLfnF/qp6almy6emiwfJr9OXegUGI9IpmDclA9A9 i587SxFjTcq8/b/xj9WoscWR7ZwClHToKBHOGaoCLIrfTyKud3KSVwfGuZDSUh/sK0yg OE84eXyy90QcvFKGErYTD1jZ1sba1wcdxvqOVgCMB+H+SzN8RJgmGbbqFT/Q5Itl6Fxe XKPw== 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:mime-version:content-transfer-encoding; bh=y2upXzLPWVLGRwG0458fGKMH0wzW7zeYu4SHHuwM9k4=; b=unU0NANCwo1NHumgiI/Y8So0V3EosZV2NpoZMU59BtNrSm1rprzcmZBYtAQGB5KTbN cxbSmlnL39mFB4zaFljk2/4jMMC/09HFSzH1AwPgku+c0Jdy4aDwcbxx0AIE6Xg3AGo+ xb4++9v4X5LvYH+QZO6OlqHkc9KVt/dpLcOjI7epVQ0HZ8A2axh64svrz0ycjpj2USx8 k65uYTKStpeqm8plMuUfc0Mo24oxw4vwkaqaCC1HX7w5JeT2t09/aGZ0YInT2ITqxWXJ dEXb7dJZYdEzhnxp+LZTfE5pc19a40FtxSAIopcM9Qz1UvRDQu9cS/WGow2d/i//FJJJ Hy/Q== X-Gm-Message-State: AOAM530tqrNm/5sTQETlNBja6jMF+UxG+D16WzpRhwWl6iSD8hHu2TT+ Xu6aR2/e9sdE6w7YjWu/MAZqpQ== X-Google-Smtp-Source: ABdhPJyskrfqJ/c4QwfqtJ+2rayWd9noi5nBNi8HA7AQIB7lsqXTyBYCnN4toqJQFQUuztuv46l2Zw== X-Received: by 2002:adf:c54a:: with SMTP id s10mr13707663wrf.58.1615546539220; Fri, 12 Mar 2021 02:55:39 -0800 (PST) Received: from dell.default ([91.110.221.204]) by smtp.gmail.com with ESMTPSA id q15sm7264962wrr.58.2021.03.12.02.55.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 02:55:38 -0800 (PST) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Philipp Reisner , Lars Ellenberg , Jens Axboe , drbd-dev@lists.linbit.com, linux-block@vger.kernel.org Subject: [PATCH 04/11] block: drbd: drbd_state: Fix some function documentation issues Date: Fri, 12 Mar 2021 10:55:23 +0000 Message-Id: <20210312105530.2219008-5-lee.jones@linaro.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210312105530.2219008-1-lee.jones@linaro.org> References: <20210312105530.2219008-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-block@vger.kernel.org Fixes the following W=1 kernel build warning(s): drivers/block/drbd/drbd_state.c:913: warning: Function parameter or member 'connection' not described in 'is_valid_soft_transition' drivers/block/drbd/drbd_state.c:913: warning: Excess function parameter 'device' description in 'is_valid_soft_transition' drivers/block/drbd/drbd_state.c:1054: warning: Function parameter or member 'warn' not described in 'sanitize_state' drivers/block/drbd/drbd_state.c:1054: warning: Excess function parameter 'warn_sync_abort' description in 'sanitize_state' drivers/block/drbd/drbd_state.c:1703: warning: Function parameter or member 'state_change' not described in 'after_state_ch' Cc: Philipp Reisner Cc: Lars Ellenberg Cc: Jens Axboe Cc: drbd-dev@lists.linbit.com Cc: linux-block@vger.kernel.org Signed-off-by: Lee Jones --- drivers/block/drbd/drbd_state.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/drivers/block/drbd/drbd_state.c b/drivers/block/drbd/drbd_state.c index 0067d328f0b56..b8a27818ab3f8 100644 --- a/drivers/block/drbd/drbd_state.c +++ b/drivers/block/drbd/drbd_state.c @@ -904,9 +904,9 @@ is_valid_state(struct drbd_device *device, union drbd_state ns) * is_valid_soft_transition() - Returns an SS_ error code if the state transition is not possible * This function limits state transitions that may be declined by DRBD. I.e. * user requests (aka soft transitions). - * @device: DRBD device. - * @ns: new state. * @os: old state. + * @ns: new state. + * @connection: DRBD connection. */ static enum drbd_state_rv is_valid_soft_transition(union drbd_state os, union drbd_state ns, struct drbd_connection *connection) @@ -1044,7 +1044,7 @@ static void print_sanitize_warnings(struct drbd_device *device, enum sanitize_st * @device: DRBD device. * @os: old state. * @ns: new state. - * @warn_sync_abort: + * @warn: placeholder for returned state warning. * * When we loose connection, we have to set the state of the peers disk (pdsk) * to D_UNKNOWN. This rule and many more along those lines are in this function. @@ -1696,6 +1696,7 @@ static bool lost_contact_to_peer_data(enum drbd_disk_state os, enum drbd_disk_st * @os: old state. * @ns: new state. * @flags: Flags + * @state_change: state change to broadcast */ static void after_state_ch(struct drbd_device *device, union drbd_state os, union drbd_state ns, enum chg_state_flags flags,