From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id B4855F01821 for ; Fri, 6 Mar 2026 10:32:03 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 9D77C10ECCA; Fri, 6 Mar 2026 10:32:02 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=intel.com header.i=@intel.com header.b="Z0Z8lTKQ"; dkim-atps=neutral Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.9]) by gabe.freedesktop.org (Postfix) with ESMTPS id D3BBA10ECC7; Fri, 6 Mar 2026 10:32:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1772793121; x=1804329121; h=from:to:cc:subject:in-reply-to:references:date: message-id:mime-version:content-transfer-encoding; bh=CgIUiqoctAst7HrTIjj+1cX/4J2lpJfXl0eA3wafb4Y=; b=Z0Z8lTKQnWmN2n3mR4OaXF+YsXA1anU87/0NsNz1q4dareO9Ybo7TswY ZCqnxJVBizXJPjyEadwEdskHLI2Iz2exAHiVDp6BapG4ffwNVR+sjrzLR phZa6r3Oyn8abw54LdmOMPUsN4DRtVWpVswufQxBztJGHDSoXztZ0vC18 dF8lcG+HbrPG95xghMC9rZ8LwAKtFrPwWnair/rMUuSX7T2Lwj/drB4L6 NzuIp8mkBglys+oUE/DLazpBdt/iFWPIx4GJfj5WCTvIlJoPtEkKBRU6G s6TcKBRJNLMx5vIBrk6f+aW4kDtBKmg3dXCGIXtNed4xrmrL1ueyk5Meb w==; X-CSE-ConnectionGUID: rfiDHvccShaGGr5LyenLig== X-CSE-MsgGUID: Ou8Z2X10Qa6gqAc3R8wJCg== X-IronPort-AV: E=McAfee;i="6800,10657,11720"; a="84608498" X-IronPort-AV: E=Sophos;i="6.23,104,1770624000"; d="scan'208";a="84608498" Received: from orviesa002.jf.intel.com ([10.64.159.142]) by fmvoesa103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Mar 2026 02:32:00 -0800 X-CSE-ConnectionGUID: OmgBK8SKQaiVRecYw+UDYw== X-CSE-MsgGUID: EU9FzmMgRjCvKQNuiw0SXQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.23,104,1770624000"; d="scan'208";a="249446474" Received: from jkrzyszt-mobl2.ger.corp.intel.com (HELO localhost) ([10.245.246.191]) by orviesa002-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 Mar 2026 02:31:58 -0800 From: Jani Nikula To: Randy Dunlap , linux-kernel@vger.kernel.org Cc: Randy Dunlap , Ville =?utf-8?B?U3lyasOkbMOk?= , intel-gfx@lists.freedesktop.org, intel-xe@lists.freedesktop.org Subject: Re: [PATCH RESEND] iopoll: fix parameter names in kernel-doc In-Reply-To: <20260306063829.2059375-1-rdunlap@infradead.org> Organization: Intel Finland Oy - BIC 0357606-4 - c/o Alberga Business Park, 6 krs Bertel Jungin Aukio 5, 02600 Espoo, Finland References: <20260306063829.2059375-1-rdunlap@infradead.org> Date: Fri, 06 Mar 2026 12:31:54 +0200 Message-ID: <7b4ab61091b0bd032e129e46237f707d2448ca08@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: intel-xe@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Intel Xe graphics driver List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-xe-bounces@lists.freedesktop.org Sender: "Intel-xe" On Thu, 05 Mar 2026, Randy Dunlap wrote: > Correct the parameter names to avoid kernel-doc warnings: > > Warning: include/linux/iopoll.h:169 function parameter 'sleep_us' not > described in 'read_poll_timeout_atomic' > Warning: ../include/linux/iopoll.h:169 function parameter > 'sleep_before_read' not described in 'read_poll_timeout_atomic' I think the right fix is to rename the parameters instead. They're passed on to poll_timeout_us_atomic() where the parameters are called delay_us and delay_before_op, emphasizing that this is atomic i.e. no sleep. BR, Jani. > > Fixes: 9df8043a546d ("iopoll: Generalize read_poll_timeout() into poll_ti= meout_us()") > Signed-off-by: Randy Dunlap > --- > Cc: Ville Syrj=C3=A4l=C3=A4 > Cc: Jani Nikula > Cc: intel-gfx@lists.freedesktop.org > Cc: intel-xe@lists.freedesktop.org > --- > include/linux/iopoll.h | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > --- linux-next-20260304.orig/include/linux/iopoll.h > +++ linux-next-20260304/include/linux/iopoll.h > @@ -150,16 +150,16 @@ > * @op: accessor function (takes @args as its arguments) > * @val: Variable to read the value into > * @cond: Break condition (usually involving @val) > - * @delay_us: Time to udelay between reads in us (0 tight-loops). Please > + * @sleep_us: Time to udelay between reads in us (0 tight-loops). Please > * read udelay() function description for details and > * limitations. > * @timeout_us: Timeout in us, 0 means never timeout > - * @delay_before_read: if it is true, delay @delay_us before read. > + * @sleep_before_read: if it is true, delay @sleep_us before read. > * @args: arguments for @op poll > * > * This macro does not rely on timekeeping. Hence it is safe to call ev= en when > * timekeeping is suspended, at the expense of an underestimation of wal= l clock > - * time, which is rather minimal with a non-zero delay_us. > + * time, which is rather minimal with a non-zero @sleep_us. > * > * When available, you'll probably want to use one of the specialized > * macros defined below rather than this macro directly. --=20 Jani Nikula, Intel