From patchwork Mon Nov 20 15:07:56 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andy Shevchenko X-Patchwork-Id: 13461496 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6A484C197A0 for ; Mon, 20 Nov 2023 15:08:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233925AbjKTPII (ORCPT ); Mon, 20 Nov 2023 10:08:08 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32816 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233928AbjKTPII (ORCPT ); Mon, 20 Nov 2023 10:08:08 -0500 Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.115]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E7B12AC; Mon, 20 Nov 2023 07:08:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1700492884; x=1732028884; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=XC0jD2RABWGMfa8yVKvouRVBZBGeLxpiuU0ibqzkN2k=; b=XvV30hUoOhcHuRCoiTx4t1yVAGccecUuroK0UFkb3COSV4ojbkl8p/Yy wk47O7qfHMSSY3c3p1k7kyM105CSdvw7kwczhoQiwkErTwleaoTKTlG/c ybNf0Kr9CEMfJsZOVCfNg9Rtjf2FPzTAfvAe2AixlZQBkr30C1oGCsXZ9 CAGiAwA1V4VWcerF5uGGzBr1FFAi7DcRHqm0Dd9zaw0Oazvw2coumo8T0 T11a8Pdwaz+CLwW1kDvaapra5La5cm2U2xn0oXXZeTI3kHnLykL/Et6oA f6Qcyv6SNQinWwUxONZZCpxFm8zhg9Fof5sQT+SPGBERXWotcnTXoPn5p Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10900"; a="391416984" X-IronPort-AV: E=Sophos;i="6.04,214,1695711600"; d="scan'208";a="391416984" Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Nov 2023 07:08:04 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10900"; a="910127927" X-IronPort-AV: E=Sophos;i="6.04,214,1695711600"; d="scan'208";a="910127927" Received: from black.fi.intel.com ([10.237.72.28]) by fmsmga001.fm.intel.com with ESMTP; 20 Nov 2023 07:08:02 -0800 Received: by black.fi.intel.com (Postfix, from userid 1003) id E9E9E6B; Mon, 20 Nov 2023 17:08:00 +0200 (EET) From: Andy Shevchenko To: Andy Shevchenko , platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Rajneesh Bhardwaj , "David E. Box" , Hans de Goede , =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Mark Gross , kernel test robot Subject: [PATCH v1 1/1] platform/x86: intel_telemetry: Fix kernel doc descriptions Date: Mon, 20 Nov 2023 17:07:56 +0200 Message-ID: <20231120150756.1661425-1-andriy.shevchenko@linux.intel.com> X-Mailer: git-send-email 2.43.0.rc1.1.gbec44491f096 MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: platform-driver-x86@vger.kernel.org LKP found issues with a kernel doc in the driver: core.c:116: warning: Function parameter or member 'ioss_evtconfig' not described in 'telemetry_update_events' core.c:188: warning: Function parameter or member 'ioss_evtconfig' not described in 'telemetry_get_eventconfig' It looks like it were copy'n'paste typos when these descriptions had been introduced. Fix the typos. Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202310070743.WALmRGSY-lkp@intel.com/ Signed-off-by: Andy Shevchenko --- drivers/platform/x86/intel/telemetry/core.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/platform/x86/intel/telemetry/core.c b/drivers/platform/x86/intel/telemetry/core.c index fdf55b5d6948..e4be40f73eeb 100644 --- a/drivers/platform/x86/intel/telemetry/core.c +++ b/drivers/platform/x86/intel/telemetry/core.c @@ -102,7 +102,7 @@ static const struct telemetry_core_ops telm_defpltops = { /** * telemetry_update_events() - Update telemetry Configuration * @pss_evtconfig: PSS related config. No change if num_evts = 0. - * @pss_evtconfig: IOSS related config. No change if num_evts = 0. + * @ioss_evtconfig: IOSS related config. No change if num_evts = 0. * * This API updates the IOSS & PSS Telemetry configuration. Old config * is overwritten. Call telemetry_reset_events when logging is over @@ -176,7 +176,7 @@ EXPORT_SYMBOL_GPL(telemetry_reset_events); /** * telemetry_get_eventconfig() - Returns the pss and ioss events enabled * @pss_evtconfig: Pointer to PSS related configuration. - * @pss_evtconfig: Pointer to IOSS related configuration. + * @ioss_evtconfig: Pointer to IOSS related configuration. * @pss_len: Number of u32 elements allocated for pss_evtconfig array * @ioss_len: Number of u32 elements allocated for ioss_evtconfig array *