From patchwork Thu Dec 21 03:36:20 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 181984 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2483:b0:fb:cd0c:d3e with SMTP id q3csp163850dyi; Wed, 20 Dec 2023 19:36:40 -0800 (PST) X-Google-Smtp-Source: AGHT+IEoGQt9tOjyYzW14b+JDZpWD33OKudSFNDtXYAkpnYU/CMN8BgDPL61hIXZDVn1cgK31+o5 X-Received: by 2002:a05:651c:1315:b0:2cc:8e11:be79 with SMTP id u21-20020a05651c131500b002cc8e11be79mr975407lja.64.1703129800180; Wed, 20 Dec 2023 19:36:40 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703129800; cv=none; d=google.com; s=arc-20160816; b=JN4/uuB8OU+AQKirV0KEEzCTSY/oXoDZg+UxQO/zT0NNuXiLj/eztwiTKCfPgPbr6J 6rsFL+FSf0sSi/j1tsuePmvceJgpoyHtB91FbjjE/OuXl87c5AzQa9jSoXh6d/4ivyso AMhzxrw3dPDStOyuk2mH5fjcbkLGRuOpvsJdXDG1zoUihoPqZE6m/obxghl530ys9yDY N87DgXB+F69uKuQVRWZIrtJRZVcoygu2ol8J3yHxWWH1qpVcRC/GMtggM5VSyUSwNBNB L6wY4wpGGkmE7ybKWEUP2qPhwFz2eNk5N5+FtWd1z8+3y9zo/Vjs3cJtKMBtHdPl4J3/ 1Swg== ARC-Message-Signature: i=1; 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=k8hLjy7/0rfR5qXAt0qHIi9EgLbOXhbv/0lSI0ys1J4=; fh=iCEb1xwemUWF3kM6sof22TGnlthFlIhEGhXzWwGnkdw=; b=F8N7APD42G7QhQ0DzuvDpP0RGA7R4AdfAis02AhbotCdjrMMALy0e9jVZljZrM35rX NRGGnqwyIaZtvud/j7mYssxZ2SP5uJ3zPPW5VYd7RfrVXi/F+bGpmQnGeA++ojPiopQD t+TTiivKPzKpTe4iLxQ6T6R3MDuhrOz2TDBKrZqqR8o1U1cHdL2APwOIFg1alp3nBA3Y +8jTRMPuZVDs2KpeZCebA8tIJmRvhfYL2xog/9N3UaMAiIHIyvJpsxhnUs8nHB+SmnuB nnIlo8dlUKlT9LkBLxQ1bcQSR9pS7mGEZRLmZzzzhCAqm6xILxVTZ4OTpmVMcbetm14h +0HQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=QMzEtLfD; spf=pass (google.com: domain of linux-kernel+bounces-7814-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-7814-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id cz17-20020a0564021cb100b005514bcc4070si428895edb.299.2023.12.20.19.36.39 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Dec 2023 19:36:40 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-7814-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=@infradead.org header.s=bombadil.20210309 header.b=QMzEtLfD; spf=pass (google.com: domain of linux-kernel+bounces-7814-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-7814-ouuuleilei=gmail.com@vger.kernel.org" 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 C59BF1F23C17 for ; Thu, 21 Dec 2023 03:36:39 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id D04B47465; Thu, 21 Dec 2023 03:36:27 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="QMzEtLfD" X-Original-To: linux-kernel@vger.kernel.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (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 A4EDD4A19 for ; Thu, 21 Dec 2023 03:36:23 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=k8hLjy7/0rfR5qXAt0qHIi9EgLbOXhbv/0lSI0ys1J4=; b=QMzEtLfDlc9tKFEz5RoH9gmnIy +eG5d7WM5y9VfoCi4L2AIHQsnnuICT9+FUK0CWAJjqVAptlEPjwPd8g0n8HDFSSTs/vexOQEmaoXu ab5My75boInnDu6JpOXB4L/zKK54UkP+mM9LJx3570G+4fzXgWEucqDSEu2/E2u0SnWqVYALAHcu0 ARdnsnfwAApxyAoZC1BCEtgw+li8j4kAHA6RWpXvAMbVEyI4jSc0uK0qbDUiikn1roj9fRGTLhCHT n05s/X6zkSxEfvcZARvvW3VxpQ7+OVCmeaZBO2dT9dTvbLGjAoEKfv7Nsi/J6a65laEcJVKR4KYdd yenjODKw==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1rG9rB-001cA4-1e; Thu, 21 Dec 2023 03:36:21 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Thomas Gleixner , Ingo Molnar , Borislav Petkov , Dave Hansen , x86@kernel.org, Jonathan Corbet Subject: [PATCH] x86/tsc: correct kernel-doc notation Date: Wed, 20 Dec 2023 19:36:20 -0800 Message-ID: <20231221033620.32379-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.43.0 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: 1785861033154148859 X-GMAIL-MSGID: 1785861033154148859 Add or modify function descriptions to remove kernel-doc warnings: tsc.c:655: warning: missing initial short description on line: * native_calibrate_tsc tsc.c:1339: warning: Excess function parameter 'cycles' description in 'convert_art_ns_to_tsc' tsc.c:1339: warning: Excess function parameter 'cs' description in 'convert_art_ns_to_tsc' tsc.c:1373: warning: Function parameter or member 'work' not described in 'tsc_refine_calibration_work' Signed-off-by: Randy Dunlap Cc: Thomas Gleixner Cc: Ingo Molnar Cc: Borislav Petkov Cc: Dave Hansen Cc: x86@kernel.org Cc: Jonathan Corbet --- arch/x86/kernel/tsc.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff -- a/arch/x86/kernel/tsc.c b/arch/x86/kernel/tsc.c --- a/arch/x86/kernel/tsc.c +++ b/arch/x86/kernel/tsc.c @@ -652,7 +652,7 @@ success: } /** - * native_calibrate_tsc + * native_calibrate_tsc - determine TSC frequency * Determine TSC frequency via CPUID, else return 0. */ unsigned long native_calibrate_tsc(void) @@ -1328,9 +1328,9 @@ EXPORT_SYMBOL(convert_art_to_tsc); * * Return: * struct system_counterval_t - system counter value with the pointer to the - * corresponding clocksource - * @cycles: System counter value - * @cs: Clocksource corresponding to system counter value. Used + * corresponding clocksource: + * cycles: System counter value + * cs: Clocksource corresponding to system counter value. Used * by timekeeping code to verify comparability of two cycle * values. */ @@ -1357,7 +1357,7 @@ static void tsc_refine_calibration_work( static DECLARE_DELAYED_WORK(tsc_irqwork, tsc_refine_calibration_work); /** * tsc_refine_calibration_work - Further refine tsc freq calibration - * @work - ignored. + * @work: ignored. * * This functions uses delayed work over a period of a * second to further refine the TSC freq value. Since this is