Received: by 2002:a05:6a10:6744:0:0:0:0 with SMTP id w4csp811914pxu; Fri, 23 Oct 2020 14:00:41 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxDQnfYOkh+XhR8wDQTgVZX39crX7lTU6PK67KCZ6vnbTZNS95Ybx3eHTOr+PsuLl5U++Gr X-Received: by 2002:aa7:c608:: with SMTP id h8mr4062843edq.16.1603486841441; Fri, 23 Oct 2020 14:00:41 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1603486841; cv=none; d=google.com; s=arc-20160816; b=gXLOI4soQHd0Mg65XG0/YHUu7q3KpgcHFyl1Fc5QVxWQkQsK2lN+vnJ4KoWa7F8n7T M2Dd51b1sLVr5rGfL0nSH8w/1m/NUdjb/NxBUnQUN8OaHXgXbFuufMa1QrgLCxOPNSlr V2NHd05U41r3wAV0sqHKwfk0j44WczfZI2dnief8vqkm49eKK9xT+98yMcWtVDJlhv79 m0mnVmaPJ7TTqS7+nrl7Jx0pfl4gP5eyaaoNcM2ga6eEKVV7NNzhPMYIbraF8NFc6ZDE 8HXGoQC9hVIObMaFHGXNJ3ULfrYSip8Ho+/COV9UcHjOt+H7W1HkwDpM6lpXyW2BS211 FctQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=fzGX81u2/mFktIY6rK6x7/6wYgKprYbt4C9pF4kuWag=; b=V8hB2HHZ00meO3ceHTiaNXeJG246a+Ty6iC6eDsbnbtTpIdRjR5EOwCcwHjz/DKu5v 6zqejl1Gg8e6O3PuBAffBI5TqmlF0LedioPOkKlCBHSsZNzPo4kRyOVuwDrj4ClAYP95 VUu6Ozui2Td2VRWULntF0N9sp1Mx73Gw8iXV14ygoPbrvjto+8tfaXQK3UJ+wXHWOUQt KbqkO8lVUU6Lueo4/awS48kGJMKcIxi807KaSkFuYAhvzupILukdmIYKkZW9UvobMOcz XHrtHCmh4XTiJMxEV+5Iu0jJFw6I6tyd3Px0npm3vjL44giovrP/6qDBJvgghMlpZAxx xDjQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=Z4wu7n60; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id z2si1683011ejr.636.2020.10.23.14.00.18; Fri, 23 Oct 2020 14:00:41 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=Z4wu7n60; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751563AbgJWQf4 (ORCPT + 99 others); Fri, 23 Oct 2020 12:35:56 -0400 Received: from mail.kernel.org ([198.145.29.99]:33328 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751855AbgJWQdu (ORCPT ); Fri, 23 Oct 2020 12:33:50 -0400 Received: from mail.kernel.org (ip5f5ad5a3.dynamic.kabel-deutschland.de [95.90.213.163]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 78D5B246C1; Fri, 23 Oct 2020 16:33:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1603470828; bh=J7G13+aNnMy7mzwjj7Q8DL+RJxJZp8RG7EudgPBJ24s=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Z4wu7n60GcgT4RSJWOAmn32w4yvcDUMC9Gq+sO5boca3EDDCS9BSq26wyefmBcxpG SHkwx39qeGaoAJXVwRd/15hNjEL7H55jJyERrYkWGVyIwFB0D2/9vTO0gmwn1Smq34 U8Vn0LIkHuiZ+O5Fp7y5z/mIGWW2dvqo+5VqFIvY= Received: from mchehab by mail.kernel.org with local (Exim 4.94) (envelope-from ) id 1kW00g-002AxJ-EX; Fri, 23 Oct 2020 18:33:46 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , "Jonathan Corbet" , Thomas Gleixner , linux-kernel@vger.kernel.org Subject: [PATCH v3 43/56] hrtimer: fix kernel-doc markups Date: Fri, 23 Oct 2020 18:33:30 +0200 Message-Id: <117905e796d1dd4920ecd7f9f917f95e15784c2f.1603469755.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The hrtimer_get_remaining() markup is documenting, instead, __hrtimer_get_remaining(), as it is placed at the C file. In order to properly document it, a kernel-doc markup is needed together with the function prototype. So, add a new one, while preserving the existing one, just fixing the function name. The hrtimer_is_queued prototype has a typo: it is using '=' character instead of '-' to split: identifier - description as required by kernel-doc markup. Signed-off-by: Mauro Carvalho Chehab --- include/linux/hrtimer.h | 6 +++++- kernel/time/hrtimer.c | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h index 107cedd7019a..bb5e7b0a4274 100644 --- a/include/linux/hrtimer.h +++ b/include/linux/hrtimer.h @@ -447,6 +447,10 @@ static inline void hrtimer_restart(struct hrtimer *timer) /* Query timers: */ extern ktime_t __hrtimer_get_remaining(const struct hrtimer *timer, bool adjust); +/** + * hrtimer_get_remaining - get remaining time for the timer + * @timer: the timer to read + */ static inline ktime_t hrtimer_get_remaining(const struct hrtimer *timer) { return __hrtimer_get_remaining(timer, false); @@ -458,7 +462,7 @@ extern u64 hrtimer_next_event_without(const struct hrtimer *exclude); extern bool hrtimer_active(const struct hrtimer *timer); /** - * hrtimer_is_queued = check, whether the timer is on one of the queues + * hrtimer_is_queued - check, whether the timer is on one of the queues * @timer: Timer to check * * Returns: True if the timer is queued, false otherwise diff --git a/kernel/time/hrtimer.c b/kernel/time/hrtimer.c index 3624b9b5835d..61c39ff68439 100644 --- a/kernel/time/hrtimer.c +++ b/kernel/time/hrtimer.c @@ -1289,7 +1289,7 @@ int hrtimer_cancel(struct hrtimer *timer) EXPORT_SYMBOL_GPL(hrtimer_cancel); /** - * hrtimer_get_remaining - get remaining time for the timer + * __hrtimer_get_remaining - get remaining time for the timer * @timer: the timer to read * @adjust: adjust relative timers when CONFIG_TIME_LOW_RES=y */ -- 2.26.2