[tip:,timers/core] jiffies: Transform comment about time_* functions into DOC block
Message ID | 170833233221.398.8859472545073053578.tip-bot2@tip-bot2 |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-70951-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:693c:2685:b0:108:e6aa:91d0 with SMTP id mn5csp1155968dyc; Mon, 19 Feb 2024 00:46:45 -0800 (PST) X-Forwarded-Encrypted: i=3; AJvYcCW+lZM3e0M7Xuf8r7FQbhLw6vA9jt6TXI7uWib9NnlojioltC0XL0RvcJvq/15fFtYAItHq/8b9dywkxbFvuaxz08VIqQ== X-Google-Smtp-Source: AGHT+IFqQzNJN4Vcmmbiu58PwlH7SsRfJviGnv1d8Yd6dBnyDQN8kBVL/Si0cpyIBeduWvoX1ygB X-Received: by 2002:a05:6402:3788:b0:563:ccd1:26bf with SMTP id et8-20020a056402378800b00563ccd126bfmr9606241edb.37.1708332405365; Mon, 19 Feb 2024 00:46:45 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1708332405; cv=pass; d=google.com; s=arc-20160816; b=azmiwEWEiT5uW0FZVWQUPnMLE6R7KpT+BC9nw3UaT6mnFs55OMj13KBCX9KSDhfZS8 /sOPVBM7ZVGyxURcuICkitEiDg3jldYITOm1m778InGQ/goBeQdgdVnDnYa2q7yX1ZsU pNeqhKL4cXv/eJFQ8pAcwRjMznTjtLxoaCYqE7lRRe8iNpqDxj26ECDdHu0CYdNahamg fqHrBMYHJPA6pOPmaDmdbO9ikQ8pqYaRrbnjgZNWokT1RYFOUWvJwAnvGkB1GhwL/jqZ F2Vg0r46dihGBBdhUcEw16Skn994twTDxsGsWmaRt2rKL8UPZFOjb9oaOWyicyJASmti PPxA== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:precedence:robot-unsubscribe:robot-id :message-id:mime-version:list-unsubscribe:list-subscribe:list-id :precedence:references:in-reply-to:cc:subject:to:reply-to:sender :from:dkim-signature:dkim-signature:date; bh=Ta5lSvZpccXebEpA1KWrl8gTPGe/xHUHEGHA/2xdOZ8=; fh=9TzET5t9qt7/NzJ5Qjz3uc/2R2GVPigMRGq+4RapPhI=; b=RBxL7xuqP3B5nPhHzgCkcgVV61og5Ashd6pO1oANVlRmOWKZrkot8EYZgUlENhtQKX LAblGsl/Zj5kadIS0bfEgjS0Vs/N/PZcHnwTQhHsX2j3gOzznm7/FpAanJO/KB+oxJ8z 35TMidt1mLvOBywXxYRkk/5YGbMu2R909MXUu5w+FWwzpVX/kOszuechuP7S3oOrlrL1 GwJdoFbhuoDue9FyMddPvR4NE6DuDEaVyLhyXO0taIkTfXkBEYRwwlpppyAI/4wWu+Ab O0VqxjsFxq4Vqv8UmJdssnCyot/EKFKiuqh87tL6tFsCiygxH2dyhZ3xi/AFDCbjStLT 4p7A==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=dTi12h1W; 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-70951-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-70951-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=linutronix.de Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id i38-20020a0564020f2600b005642f0a0ba0si1782458eda.441.2024.02.19.00.46.45 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 19 Feb 2024 00:46:45 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-70951-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@linutronix.de header.s=2020 header.b=dTi12h1W; 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-70951-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-70951-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 am.mirrors.kernel.org (Postfix) with ESMTPS id 412061F2195A for <ouuuleilei@gmail.com>; Mon, 19 Feb 2024 08:46:35 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id DBDE723763; Mon, 19 Feb 2024 08:45:39 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="dTi12h1W"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="Bd/xjVox" 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 A0ABD2135A; Mon, 19 Feb 2024 08:45:35 +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=1708332337; cv=none; b=rfpqotvNzrW/w6UR/OFKB7SiZkq+RXHwIP+/mF0I9jb7fAQz+wa97bXcNnb0lEojmUQef0cMQcPz6FQemgiRJJVS4kQEG5Bi5F/dnlFCzZnLOPZRbAxd5GkSlrLRJXl+N/pWnXj0JfjVhTYsXZKv/3vmm9fW1gKz2bOCdGsuk9U= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1708332337; c=relaxed/simple; bh=8DF2yuQdV5gqKG8rHi9GEvERAsRsOWhC9YU+4aMwJ4c=; h=Date:From:To:Subject:Cc:In-Reply-To:References:MIME-Version: Message-ID:Content-Type; b=J/hQvKCIo1zUyDeyRQqTp1wIIUo4VjeaH1xjLQNLEENp1fUj8msdOPdV4eESTvz4hh2kFppaz9+3ay3rZIVuPpOZfJLVO1FSsHGPV4Dm2H6crSMvQx0ViVUDpGXzGrEPNumvpDGeuA/XAbQaQHrKXdaz9hvlr9toK+JuTHgB/L0= 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=dTi12h1W; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=Bd/xjVox; 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 Date: Mon, 19 Feb 2024 08:45:32 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1708332333; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Ta5lSvZpccXebEpA1KWrl8gTPGe/xHUHEGHA/2xdOZ8=; b=dTi12h1Wtb/RULhJ+lrrB3o2JwWQs126S4UlAuQeGPn4Rt4kDsF8V/I+3dp1OzGnRGXNSh gbdDvkYrcJ3Wlk/Wy8BUpf0xabQixGQ/CWJfqh4lQg5DP6YJ4hWpgQsz/2Elue2seqr4Wv m7omhppmFte9hzUcrsJmXwv9L7fy2gsndm+wkNLaF/nVrzN0JlrJFdiYlRv5dtlAYk1mcl 29oB2voAoXk1YUXLve1/U1c4w1hpACBW+DqVGgR/5CFkiTPzRsoeRD0DwyZCtl1g8CmSKU WqqjYS68P7aANvvWuOVibXH7ecSiTE//dSzWgq0Es8Dr+SC/q9CzN36cTKDXWA== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1708332333; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Ta5lSvZpccXebEpA1KWrl8gTPGe/xHUHEGHA/2xdOZ8=; b=Bd/xjVoxFYb3CT7muvOs/tyauB/YMb6IBnxjiDVxoFjFcxZuohset3Upa93osyKQoUv0/7 Cnbj8mmfxg2bjpAw== From: "tip-bot2 for Anna-Maria Behnsen" <tip-bot2@linutronix.de> Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: timers/core] jiffies: Transform comment about time_* functions into DOC block Cc: "Anna-Maria Behnsen" <anna-maria@linutronix.de>, Thomas Gleixner <tglx@linutronix.de>, x86@kernel.org, linux-kernel@vger.kernel.org In-Reply-To: <20240123164702.55612-6-anna-maria@linutronix.de> References: <20240123164702.55612-6-anna-maria@linutronix.de> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Message-ID: <170833233221.398.8859472545073053578.tip-bot2@tip-bot2> Robot-ID: <tip-bot2@linutronix.de> Robot-Unsubscribe: Contact <mailto:tglx@linutronix.de> to get blacklisted from these emails Precedence: bulk Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788903055614565257 X-GMAIL-MSGID: 1791316360660099741 |
Series |
[tip:,timers/core] jiffies: Transform comment about time_* functions into DOC block
|
|
Commit Message
tip-bot2 for Thomas Gleixner
Feb. 19, 2024, 8:45 a.m. UTC
The following commit has been merged into the timers/core branch of tip: Commit-ID: c92a7eb6c642812fb08851e580973c3b83e0227c Gitweb: https://git.kernel.org/tip/c92a7eb6c642812fb08851e580973c3b83e0227c Author: Anna-Maria Behnsen <anna-maria@linutronix.de> AuthorDate: Tue, 23 Jan 2024 17:46:59 +01:00 Committer: Thomas Gleixner <tglx@linutronix.de> CommitterDate: Mon, 19 Feb 2024 09:38:00 +01:00 jiffies: Transform comment about time_* functions into DOC block 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 <anna-maria@linutronix.de> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/r/20240123164702.55612-6-anna-maria@linutronix.de --- 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 e0ae2a4..d9f1435 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. */ /**