From patchwork Mon Nov 20 07:18:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matti Vaittinen X-Patchwork-Id: 166962 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:9910:0:b0:403:3b70:6f57 with SMTP id i16csp2028603vqn; Sun, 19 Nov 2023 23:20:59 -0800 (PST) X-Google-Smtp-Source: AGHT+IGhPSyPUQ+naUWTu7AqhmsBTJSUcuknpq+dcS3d3yEiKEEvkKSozjdnuzSsewYzlabMeWZb X-Received: by 2002:a05:6a00:98b:b0:6c3:402a:d54d with SMTP id u11-20020a056a00098b00b006c3402ad54dmr5659656pfg.11.1700464858754; Sun, 19 Nov 2023 23:20:58 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1700464858; cv=none; d=google.com; s=arc-20160816; b=IOfgBBr4/DQlEIc3D0yIX4SjZHQHizdAqQAfds0BkmTH9/wLFrQeebuxQMzUEJcNqD HR+v7MlY1s8dxOXn3sSZuhGdzC4VxZE/ehiITTNAOCsfatG6hY7XAvNNPoUWGXJZ6xSt 2OWl3ErARhEWC84j60RiL+DPaOFa2enaAldWUeCcxd7cRzwID8eVtHNyXEZ2KMtcBk5L yOO71/daYFvW+5C3hL6DdeZeLGRx9FdO9PCE3SXJQgO2WHnwliS7lOkcs2Eb7S68uy29 W5c2+T72NNoW8W9i9imgVtD8+61Jtcj/tQApPnMGroalwqhQNRxDPs2Cz64xAeuBZ9Nk nsuw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-disposition:mime-version:message-id :subject:cc:to:from:date:dkim-signature; bh=FRhnT6SBAvyFzdcnWB9ep0kLqDtC5zY+wmDjKO7YL10=; fh=cOfJye1SM6JsWEoOpauP7rxBDFxSPMte6TRyPgeWd/s=; b=TImeJmwhZQx39DaHvhnyxFEQN23h4yYfkGUOuOB13vsQKx479oU+hY9/vGUgkU1tal zcxcvNqSomT81SyT7yAiY8K83LXg1ETYjtwU2OHkZNxaqLYiaMBfa3Oy3JQvd51piSNl URayr5fJMhLZ9DIGiMr7CXT8W1X8ckv0rZrYeJSTPJuXaCFiIEgeMDckHq1muNGT2Q8u rnju1+HVqt8J20VGQjrnGez6dvujvKngFfNFY0D1q1/1Dl85v0cXzVZmogigXhtGqYx0 Wi0MGCdqWmNGIwc1BnTnrnVczE1/MQ+12fI5qfo0B3ozROz7IHcsxYT4KZdoL6Tvda85 ohdA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=T7V1SGgV; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from snail.vger.email (snail.vger.email. [23.128.96.37]) by mx.google.com with ESMTPS id h17-20020a056a00219100b00690f8063627si7520681pfi.38.2023.11.19.23.20.58 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 19 Nov 2023 23:20:58 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=T7V1SGgV; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by snail.vger.email (Postfix) with ESMTP id DA617805A793; Sun, 19 Nov 2023 23:19:01 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232016AbjKTHSx (ORCPT + 27 others); Mon, 20 Nov 2023 02:18:53 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54534 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229952AbjKTHSw (ORCPT ); Mon, 20 Nov 2023 02:18:52 -0500 Received: from mail-lf1-x133.google.com (mail-lf1-x133.google.com [IPv6:2a00:1450:4864:20::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D8E68A2 for ; Sun, 19 Nov 2023 23:18:48 -0800 (PST) Received: by mail-lf1-x133.google.com with SMTP id 2adb3069b0e04-50943ccbbaeso5603965e87.2 for ; Sun, 19 Nov 2023 23:18:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1700464727; x=1701069527; darn=vger.kernel.org; h=content-disposition:mime-version:message-id:subject:cc:to:from:date :from:to:cc:subject:date:message-id:reply-to; bh=FRhnT6SBAvyFzdcnWB9ep0kLqDtC5zY+wmDjKO7YL10=; b=T7V1SGgVnPRHXVRgB5c2P6wOqD9E6r6JcUSimRQla7H8EUEw7VnuWbXhrntZfRUnS7 OVcB0TY7prlhNzcmcxHiiUBB1O3M4Tn3LGm5oPQrLPaqu91sx0mmLx//zqbiUZi5MKIm mv/lG9TnWKnSCBOb9Z/EwGPymlq6SsBgc6Qd1iJo0HzNscA1KQo7vs8vsz8hqjZuWn5Y lRtdgTy3b2P2hN8WBUvUAOFRsB4xJjfIdQPB7KQyWypkTKzE4wvz7SOIn9wMODYrHW/6 pa5r4rZVpq0PrMN8m5Zuc+RPeTr/ODqfpmFBJ2fYWAmgwVtbqlMAdtimSHKbBywKe1HY WB9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700464727; x=1701069527; h=content-disposition:mime-version:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=FRhnT6SBAvyFzdcnWB9ep0kLqDtC5zY+wmDjKO7YL10=; b=JJOLLdgl+Ic1txQDG2aXppoXH0WZbGJBf5nYagvA4268/2sGf2snhu3wmX8uutamUq NxxTnEj+9of0RpFguLeuNmbO+KdG0lr70TYxidXsGU6hxConnNgzePddKuhNamr+3HHj 1/JgEV69hMV5bQSsO0Fk2mtdAvrOT9wKfI+FSuZFhEpDuYWHicd+b/Lm0o1Iy7AGZIz/ eDolPzkyy4JDcVtjmP/OHsoW3cE7DVPzI8gMKlfXFSUvS/a4SGDDgm0Qffg85vcltKUo K68L35H+Px/mH43iJsTcgt1S0o7cM7uCmFINrKOTUnJOmjQtaLz4Qa+kHL1fMUZV4JJO cx3Q== X-Gm-Message-State: AOJu0Yxhl7/iR049um+/xrLzdGsqD7uEdWjHjXt01u8W+H4k75+uec6N ASjDdMbiSY8YQPNkdL1jxCI= X-Received: by 2002:a19:c511:0:b0:502:ff3b:766f with SMTP id w17-20020a19c511000000b00502ff3b766fmr5421313lfe.6.1700464726800; Sun, 19 Nov 2023 23:18:46 -0800 (PST) Received: from dc78bmyyyyyyyyyyyyyyt-3.rev.dnainternet.fi (dc78bmyyyyyyyyyyyyyyt-3.rev.dnainternet.fi. [2001:14ba:16f8:1500::1]) by smtp.gmail.com with ESMTPSA id b30-20020a0565120b9e00b0050aab2f368dsm439880lfv.37.2023.11.19.23.18.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 19 Nov 2023 23:18:45 -0800 (PST) Date: Mon, 20 Nov 2023 09:18:33 +0200 From: Matti Vaittinen To: Matti Vaittinen , Matti Vaittinen Cc: Mark Brown , Daniel Lezcano , Randy Dunlap , linux-kernel@vger.kernel.org Subject: [PATCH RESEND] kernel/reboot: document function parameter Message-ID: MIME-Version: 1.0 Content-Disposition: inline X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_BLOCKED,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Sun, 19 Nov 2023 23:19:01 -0800 (PST) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1783066639842062584 X-GMAIL-MSGID: 1783066639842062584 The hw_failure_emergency_poweroff() has been documented using kernel doc. The documentation omits description of the function parameter 'int poweroff_delay_ms' - which seems like self-explatonary. However, the build bot is nagging about the missing parameter documentation, so add the trivial documentation to shut the bot up. Signed-off-by: Matti Vaittinen Acked-by: Randy Dunlap Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202309040349.HLOK1O5I-lkp@intel.com/ Fixes: dfa19b11385d ("reboot: Add hardware protection power-off") --- Mark, would you pick this up? (Excuse can be that the regulator framework uses the emergency_poweroff) Or any suggestions who should I CC? This has fallen through the cracks for couple of times already and I suspect this belongs to no-one specifically. kernel/reboot.c | 1 + 1 file changed, 1 insertion(+) diff --git a/kernel/reboot.c b/kernel/reboot.c index 395a0ea3c7a8..2e5fd997d49c 100644 --- a/kernel/reboot.c +++ b/kernel/reboot.c @@ -944,6 +944,7 @@ static DECLARE_DELAYED_WORK(hw_failure_emergency_poweroff_work, /** * hw_failure_emergency_poweroff - Trigger an emergency system poweroff + * @poweroff_delay_ms: Time after which the system is rebooted. In milliseconds. * * This may be called from any critical situation to trigger a system shutdown * after a given period of time. If time is negative this is not scheduled.