From patchwork Tue Jan 23 16:46:59 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Anna-Maria Behnsen X-Patchwork-Id: 191118 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2553:b0:103:945f:af90 with SMTP id p19csp488634dyi; Tue, 23 Jan 2024 09:28:18 -0800 (PST) X-Google-Smtp-Source: AGHT+IE31e8cQlH6+HD7lDQ9OwVd1wUWxSb2BXDLyQ2M558P2SXBAv1+fArCP/02QjC1tszMT5gC X-Received: by 2002:a05:6a20:2453:b0:199:b9ef:9d6b with SMTP id t19-20020a056a20245300b00199b9ef9d6bmr3779994pzc.90.1706030898197; Tue, 23 Jan 2024 09:28:18 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1706030898; cv=pass; d=google.com; s=arc-20160816; b=ZGZ+J5WP2oJj9hude3cmz6wO1KaRHuJwIZYSlswtXO8mvQNK1Ti1EpgGD9HgVIM2t+ 33Ngrp2COVckpkH9oRgFsVMlnzrcBU5LNgh01D7rc9N0/fpwhXLVU6KhwiBAzx4vDOQ9 YyIo9dbd955r1Q3PoNTEAd2EnC01cyjU1UlmSM1T8JNif+EWNPLD4vqOSKgHHKtupxpH 1bNr5YGNmWv5f4mcg0wOoFzrdF51/ecmbb3biHDAJgnafDHpoIJdgK6f7J4PAZrtbI0o yQ+R1bx6nySE/Dk0EJVWsY4DrexeJ/nuqV9CYYQLOqaBXIwfmsizPPcBu0BRTvPCBpsb K4UA== 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:references:in-reply-to:message-id :date:subject:cc:to:dkim-signature:dkim-signature:from; bh=khMougoG0mvpU1Mds2+gCdLAlfzbFK/BUtDBN3tuvqo=; fh=nOEvUOtvIydWxxQpRdVGTZdE7oDfSvGmdNyLCMjLbrA=; b=yJvplK3WKObt5W2ejHztSdNHumc7JRCGW0OOV+XTkHw2NfxjNh9XN93O3BUQZPUfPm CdE6oIiowRShZgPq0OGIGj5dKaSAEdKAeHDQbAtkLc1779l1UIYDe9KoLrpj1gfw5lXS TeBmgNSqkHFOGVLiduWnZhOJK/MaI+fVVCz7e1cYb8lYYGQPpTrG886ywabbc0jbcPx9 zem0VDzYagsciOZmlB3VIgIsLT50B/mykgzl3FL4TCEIWRW6r37TJJuR/DzNKVFnS4gC MjFWdAKqp6YYhMkz5/Em1gUAHcjFNbY1cWnhjlx2NxKPEKtJGlCw5/fICWOa3lgkPKqY ghDA== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=ozepGXdm; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e; arc=pass (i=1 spf=pass spfdomain=linutronix.de dkim=pass dkdomain=linutronix.de dmarc=pass fromdomain=linutronix.de); spf=pass (google.com: domain of linux-kernel+bounces-35706-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) smtp.mailfrom="linux-kernel+bounces-35706-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [147.75.48.161]) by mx.google.com with ESMTPS id q5-20020a056a00084500b006dbdb7770bfsi4567957pfk.178.2024.01.23.09.28.17 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 23 Jan 2024 09:28:18 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-35706-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=ozepGXdm; dkim=neutral (no key) header.i=@linutronix.de header.s=2020e; arc=pass (i=1 spf=pass spfdomain=linutronix.de dkim=pass dkdomain=linutronix.de dmarc=pass fromdomain=linutronix.de); spf=pass (google.com: domain of linux-kernel+bounces-35706-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) smtp.mailfrom="linux-kernel+bounces-35706-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de 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 sy.mirrors.kernel.org (Postfix) with ESMTPS id 9CC1FB2CACB for ; Tue, 23 Jan 2024 16:53:40 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 4BC171292E7; Tue, 23 Jan 2024 16:47:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="ozepGXdm"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="IYABCsLS" Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) (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 24A19823D9; Tue, 23 Jan 2024 16:47:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=193.142.43.55 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706028442; cv=none; b=H+jj4QmuPm/lyTHUlr1KCXTEw01gQgYO9+Mfc3nrB7IPI8J2JqtwqEZLTldgoklqqorFAqy35EQMqShlsuL4PslueYYk9KK1kwARRSoj/b73T/Ppc7GCDaib4BtWuL1m2uvHKQ5J0uqvjfbBQuhKuZbp9yxKBWAgWF6WJRSVXVs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1706028442; c=relaxed/simple; bh=99UGYF5IBxp9JpIFxVvetsxGYd/JCchgwfyQMLrGxD0=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=c4UzSwpEI7C3FqpbX+ROpyvtVxq63HIg10JPqxCNV6Q5mIc3YKI/oKfozmBvbh4iLB/9eCw/5EdZ513JkBkwy0f9R27j6HA0o0z9exGrXUU88KJtD6AGmmOJtpeNHfxJLeiRRLYYz5GQ3ITUZd1XX8f1zoYlLFPeEfMaJJLjQo8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de; spf=pass smtp.mailfrom=linutronix.de; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=ozepGXdm; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=IYABCsLS; arc=none smtp.client-ip=193.142.43.55 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linutronix.de From: Anna-Maria Behnsen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1706028437; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=khMougoG0mvpU1Mds2+gCdLAlfzbFK/BUtDBN3tuvqo=; b=ozepGXdmD3hMx/BF8U/4Jdt4uD6N1cdvJPbTdgsyFVq6VqguU9Seefjg2HIF06aWWXCbT0 +USq95oKStk3bCFvnDyUGFcy2i72mTkyaGyscol9vZeEQAFjLVn3vvXCW7iIaQdFSpfPBD BnP8nDKBWNBp4lg3T++s07+/VkhsCfDCM+oLCTO211JEDncImFRmKNf1qrRnFghxgSon/t QdtNRsW+4/NvmM81NlNZlCHSj+RMqhMzu7JIO2rX0Hyr8AX7+e1Op+izfMiOgI4QcxjbHK vWcM2JBEOOCPnGleR7XCvZX1gF114jgScsfKua8aL2qitArsNoSyJfdVsBL4Sw== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1706028437; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=khMougoG0mvpU1Mds2+gCdLAlfzbFK/BUtDBN3tuvqo=; b=IYABCsLSREXQ5FfgJQ4fye4JG2wKe+r0VkozoE+L4pxCtwZuezSYuejwBoBbCyhIxuyyGm hzGgIBDrW6/4QfCA== To: linux-kernel@vger.kernel.org Cc: Thomas Gleixner , Frederic Weisbecker , Ingo Molnar , John Stultz , Stephen Boyd , Jonathan Corbet , Clemens Ladisch , linux-doc@vger.kernel.org, Anna-Maria Behnsen Subject: [PATCH 5/8] jiffies: Transform comment about time_* functions into DOC block Date: Tue, 23 Jan 2024 17:46:59 +0100 Message-Id: <20240123164702.55612-6-anna-maria@linutronix.de> In-Reply-To: <20240123164702.55612-1-anna-maria@linutronix.de> References: <20240123164702.55612-1-anna-maria@linutronix.de> 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: 1788903055614565257 X-GMAIL-MSGID: 1788903055614565257 This general note about time_* functions is also useful to be available in kernel documentation. Therefore transform it into a kernel-doc DOC block with proper formatting. Signed-off-by: Anna-Maria Behnsen --- include/linux/jiffies.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/include/linux/jiffies.h b/include/linux/jiffies.h index e0ae2a43e0eb..d9f1435a5a13 100644 --- a/include/linux/jiffies.h +++ b/include/linux/jiffies.h @@ -102,12 +102,15 @@ static inline u64 get_jiffies_64(void) } #endif -/* - * These inlines deal with timer wrapping correctly. You are - * strongly encouraged to use them: - * 1. Because people otherwise forget - * 2. Because if the timer wrap changes in future you won't have to - * alter your driver code. +/** + * DOC: General information about time_* inlines + * + * These inlines deal with timer wrapping correctly. You are strongly encouraged + * to use them: + * + * #. Because people otherwise forget + * #. Because if the timer wrap changes in future you won't have to alter your + * driver code. */ /**