From patchwork Tue Feb 6 09:38:57 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yang Li X-Patchwork-Id: 197284 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7301:168b:b0:106:860b:bbdd with SMTP id ma11csp1424554dyb; Tue, 6 Feb 2024 01:39:35 -0800 (PST) X-Google-Smtp-Source: AGHT+IHL+EVBOAiZrkbkLIzXcqosoQLwneRDZwr+Yb1zFHRZ/RZegupWeO1/XogmlFsIQVpcT8GL X-Received: by 2002:a05:620a:2445:b0:783:d13c:cfa0 with SMTP id h5-20020a05620a244500b00783d13ccfa0mr1836765qkn.12.1707212374936; Tue, 06 Feb 2024 01:39:34 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1707212374; cv=pass; d=google.com; s=arc-20160816; b=h4htQBqE6OtN/RcI6bO93wRtSJMmlsf+xX/yLd3+Y1/l704yo1piO0DtCE967cNoAl C/14gmSiD0V0KTkEvgMpDB/438Rnnx0aJ4FFPFmdSN+/iB//1mbtNalcxlQQ/QCVcC+2 93+GKnteP7nsKymjQWu581cl70H6+OABGf2GiR0Tg3yezvQ5S2oXIUe4liHAqsgJxeZ4 PrPrdIwz0TlKq3Q5f4/SwceCAo1DTn/I0v7oQ/b7GrfiYNtLRoaQzEhU20fS7/ARfMqy He4e2T/0Kwddz7q6N4ehK/GKIPQTiGWWpksGEY1s5Epl3MW4uTvd8/l8DBMLqeM56gXg 3DDQ== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=toWhO0GkKnpG8md0AYP6xrKSj5a2GVH2yOYl3wdcLGw=; fh=pf/jIuZpDjvORB5mFt/MTSAz+A3JRaHp0xwf2BAREXs=; b=NtngXIdFldxxCTg7wJtrahWCtgHrMI74zJJ4j/jfs1zhVo4nb1i1DUWy979NWCBpGw ziQZWfUW0+q7qc/bCv+BEZw1mhJy10cOdeJ0/wyGt+hgsT8Nfyro07BiHxduTGLldDAy Z1MdBOom5BbhMAyQiYGlf4tt6XMROuK0BbCk3IBY46kRsazT2kNp6gGx+wV6M2Ukdbma oxX0L88y/jLQfj5kPol/wsCCAOW+sL2XwqeJ+1xyLInqSjbdZBd2zLuKJu9wFCS1dA5z 4bYiGbdvgtqqD27Ixporgq6v1AKITl8ICkjU70MPnvHpV5GA7k/hOsjwtO4LqR4+Uk2B Y8Pg==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linux.alibaba.com header.s=default header.b=DN2sTFai; arc=pass (i=1 spf=pass spfdomain=linux.alibaba.com dkim=pass dkdomain=linux.alibaba.com dmarc=pass fromdomain=linux.alibaba.com); spf=pass (google.com: domain of linux-kernel+bounces-54610-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-54610-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linux.alibaba.com X-Forwarded-Encrypted: i=1; AJvYcCWsAjLi6+1cuRF1gx3hxnPTuzuuQmd9dOaan5ZU2QidiexfUKc7k45Ok6Ec1tbGeJaP5GQlFeiAxjXPhIJkK4Oyh8e11Q== Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [2604:1380:45d1:ec00::1]) by mx.google.com with ESMTPS id a18-20020a05620a103200b0078328d65c15si1849730qkk.476.2024.02.06.01.39.34 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 06 Feb 2024 01:39:34 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-54610-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@linux.alibaba.com header.s=default header.b=DN2sTFai; arc=pass (i=1 spf=pass spfdomain=linux.alibaba.com dkim=pass dkdomain=linux.alibaba.com dmarc=pass fromdomain=linux.alibaba.com); spf=pass (google.com: domain of linux-kernel+bounces-54610-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-54610-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linux.alibaba.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ny.mirrors.kernel.org (Postfix) with ESMTPS id B649C1C22504 for ; Tue, 6 Feb 2024 09:39:34 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id EDCEE12DDA8; Tue, 6 Feb 2024 09:39:12 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=linux.alibaba.com header.i=@linux.alibaba.com header.b="DN2sTFai" Received: from out30-100.freemail.mail.aliyun.com (out30-100.freemail.mail.aliyun.com [115.124.30.100]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 00DDD12D146; Tue, 6 Feb 2024 09:39:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=115.124.30.100 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707212350; cv=none; b=GEyYyGXZIxVvEfRk5Gwt5HQC0GU2nJ/PkeUy7Ve8p2lkdMuATfbcSSB1OUB8dMi+vrLBwU6p+SBYNVcLjMVfltCgT8R+YaF9ToGGwjnGHxCj2bSATpM+KgEy+ZqyuzV3L6/+yNsdjmi5J/6mvBgdCmOBUfwgvyg4VBjcYHxbkVk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1707212350; c=relaxed/simple; bh=vOlUYbXqj6PLt5HGut6v/zsqfogoygFiPio5B13aQPs=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version; b=TYZS54Tu6AazjrMGp3nWyz/YnMz2CpoxJNRA0aoPHMvbEo+RB6awSx3NJn0ZrE6ljM/v4l8aw76TQhQd8PaGgwnspxHoH9uGB/YuUbGxB/deoNWThIo/NVR6uEEEpWWpVRz21uOc/qROG4P7YlvrgbSXp31O0SGA4QD3csX04iQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.alibaba.com; spf=pass smtp.mailfrom=linux.alibaba.com; dkim=pass (1024-bit key) header.d=linux.alibaba.com header.i=@linux.alibaba.com header.b=DN2sTFai; arc=none smtp.client-ip=115.124.30.100 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.alibaba.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linux.alibaba.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.alibaba.com; s=default; t=1707212339; h=From:To:Subject:Date:Message-Id:MIME-Version; bh=toWhO0GkKnpG8md0AYP6xrKSj5a2GVH2yOYl3wdcLGw=; b=DN2sTFaiG9lQwH7ajrsAtjnKt/z2IeXvS7Gyr5QSesfzlC4FHvbZY6zkcnkEU1sVoD3skhr0NIG8dL3ZK4GyiBO/FAx4q4/JpBTStF5Te3V5cYQML3rxEmBDCTQtWbTEPiptqJnD9+K8rboiFbKRAkENFtgGWdHtQHBDm7M6Z+8= X-Alimail-AntiSpam: AC=PASS;BC=-1|-1;BR=01201311R431e4;CH=green;DM=||false|;DS=||;FP=0|-1|-1|-1|0|-1|-1|-1;HT=ay29a033018046050;MF=yang.lee@linux.alibaba.com;NM=1;PH=DS;RN=5;SR=0;TI=SMTPD_---0W0D7L1b_1707212338; Received: from localhost(mailfrom:yang.lee@linux.alibaba.com fp:SMTPD_---0W0D7L1b_1707212338) by smtp.aliyun-inc.com; Tue, 06 Feb 2024 17:38:58 +0800 From: Yang Li To: wim@linux-watchdog.org, linux@roeck-us.net Cc: linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org, Yang Li Subject: [PATCH -next] watchdog: Add kernel-doc for wdt_set_timeout() Date: Tue, 6 Feb 2024 17:38:57 +0800 Message-Id: <20240206093857.62444-1-yang.lee@linux.alibaba.com> X-Mailer: git-send-email 2.20.1.7.g153144c Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1790141923271192150 X-GMAIL-MSGID: 1790141923271192150 The wdt_set_timeout function lacked a complete kernel-doc description. This patch adds missing parameter and return value descriptions in accordance with kernel-doc standards. Signed-off-by: Yang Li --- drivers/watchdog/it87_wdt.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/drivers/watchdog/it87_wdt.c b/drivers/watchdog/it87_wdt.c index 9297a5891912..3e8c15138edd 100644 --- a/drivers/watchdog/it87_wdt.c +++ b/drivers/watchdog/it87_wdt.c @@ -213,12 +213,16 @@ static int wdt_stop(struct watchdog_device *wdd) /** * wdt_set_timeout - set a new timeout value with watchdog ioctl + * @wdd: pointer to the watchdog_device structure * @t: timeout value in seconds * * The hardware device has a 8 or 16 bit watchdog timer (depends on * chip version) that can be configured to count seconds or minutes. * * Used within WDIOC_SETTIMEOUT watchdog device ioctl. + * + * Return: 0 if the timeout was set successfully, or a negative error code on + * failure. */ static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)