From patchwork Fri Oct 6 23:51:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 149464 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a888:0:b0:403:3b70:6f57 with SMTP id x8csp660703vqo; Fri, 6 Oct 2023 16:52:47 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHwE2E0X2iVm08GD+944EaTMrjcvZWLYXEq24WLEzaV1xLiw1YkTGsqB5Hsp6kMBF89sgRJ X-Received: by 2002:a17:903:443:b0:1c5:ce3c:c391 with SMTP id iw3-20020a170903044300b001c5ce3cc391mr8798145plb.12.1696636367375; Fri, 06 Oct 2023 16:52:47 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696636367; cv=none; d=google.com; s=arc-20160816; b=BtDmf6qoZIcomXYVSvV/0jvEbb1cGOjew/kbi+XVvAWq/heTQtpL/sKEGOdTEA5sWv M3hokmlN8IZpZb0u1XvTF+s8rV/fmxkJqHUblti03/D+/IkPScmUesvtcCuRnnrwCAU3 RvO7aMROPDcCxkFAQPHEDarc1xq/V2fwv7q809hz0TMZqjvJWwH6M+9s0x3XZyOCbwgM poc1IF3F2XGi3KyFxoqk2rqZnoJKbTkTXcExduawJhTpAARqEAam96GEx+aWQ4FODyyR 605AvZoj/6I0F2ekHHt887R2pmmMuv32j+K6ybpRq4L4blkwIvrFr3r0hQW2AOVoyBnU Dnlw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=eda8bkHW/wfNmnWvVarEi8u05ELZ2c0LLY0YPElc1Y0=; fh=MQGH1PDUMNifjeNf7vwB1Fp6OLUJAwp2krtUzJhAgow=; b=0DjTqnlUEVSD8E8BvBxxOxGQnhQzfoV6zv0F8VveNf5WvE9Trte4wtxSIrxxVPwXfX Wp1u8SCAufPZj7b+i7kz1GjFb1Nhc5AaE2zeUnuKavqS79+y8RJgh+4Yu/pGsmHPgTO+ i2MxMVc4mYBkbOjkp9Gdck1Vlarcr0PX0BLrI4tj5lTLidxHnV3lYnWAvQaQzJK2jl+K RRjvFVYlPy5dXplCqAdR56qrQoeYjJIlWJJf0PT4fwSLZt9Ih68CnMExVaT6XPvnWqx4 6zpDJ8wnb+qTLhedB2HgJfVJfdBgQOq/dkge9xuO7S3mzPDKg2ZlpgMUY9j5Ikzplk4t xycw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Kr8slfhv; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from snail.vger.email (snail.vger.email. [23.128.96.37]) by mx.google.com with ESMTPS id p10-20020a170902e74a00b001c73f81b24asi118726plf.521.2023.10.06.16.52.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Oct 2023 16:52:47 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=Kr8slfhv; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by snail.vger.email (Postfix) with ESMTP id 53112807592D; Fri, 6 Oct 2023 16:51:49 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at snail.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233929AbjJFXvh (ORCPT + 18 others); Fri, 6 Oct 2023 19:51:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:43162 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233696AbjJFXvg (ORCPT ); Fri, 6 Oct 2023 19:51:36 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 80B0ABD for ; Fri, 6 Oct 2023 16:51:34 -0700 (PDT) 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=eda8bkHW/wfNmnWvVarEi8u05ELZ2c0LLY0YPElc1Y0=; b=Kr8slfhvovWJW1h9cAaaosEWQB UCJkNIp+XgYlakdUDtnDKQOCta6hLiVuHDc6xTTP6+ww40zPE/LbSJ2WvoSVQkapKWp0wagwOiUuY vD87U2+F8kCZHFoqudkEq5F6UJ/p1RbBeyVq81keRvlPd2keKEqF+U65MQrCLSYRPdzVxZG/H0X9Q L9xUT2TQGMdHKh42unQfSPq5lAtxQ5EKsnrDjg8kYbTKtPuOnQGACCIGJWulsvZTmvVWuEuO0Gd8h TOGNiOTtT17WASI0L+qWkvnCLQImnmfYdYae9E2a9vsJGMkXh8EJAndCP3qWupJUckKsbxSPmWLB+ q6Z51jfA==; Received: from [50.53.46.231] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.96 #2 (Red Hat Linux)) id 1qoubV-006fdq-0Z; Fri, 06 Oct 2023 23:51:33 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , kernel test robot , Vikas Shivappa , Tony Luck , Thomas Gleixner , Fenghua Yu , Reinette Chatre , Ingo Molnar , Borislav Petkov , Dave Hansen , x86@kernel.org Subject: [PATCH] x86/intel_rdt/cqm: fix kernel-doc warnings Date: Fri, 6 Oct 2023 16:51:32 -0700 Message-ID: <20231006235132.16227-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (snail.vger.email [0.0.0.0]); Fri, 06 Oct 2023 16:51:49 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779052175067430802 X-GMAIL-MSGID: 1779052175067430802 The kernel test robot reported kernel-doc warnings here: monitor.c:34: warning: Cannot understand * @rmid_free_lru A least recently used list of free RMIDs on line 34 - I thought it was a doc line monitor.c:41: warning: Cannot understand * @rmid_limbo_count count of currently unused but (potentially) on line 41 - I thought it was a doc line monitor.c:50: warning: Cannot understand * @rmid_entry - The entry in the limbo and free lists. on line 50 - I thought it was a doc line We don't have a syntax for documenting individual data items via kernel-doc, so remove the "/**" kernel-doc markers and add a hyphen for consistency. Fixes: 6a445edce657 ("x86/intel_rdt/cqm: Add RDT monitoring initialization") Fixes: 24247aeeabe9 ("x86/intel_rdt/cqm: Improve limbo list processing") Signed-off-by: Randy Dunlap Reported-by: kernel test robot Link: https://lore.kernel.org/all/202310062356.lX3xpLP9-lkp@intel.com/ Cc: Vikas Shivappa Cc: Tony Luck Cc: Thomas Gleixner Cc: Fenghua Yu Cc: Reinette Chatre Cc: Ingo Molnar Cc: Borislav Petkov Cc: Dave Hansen Cc: x86@kernel.org Reviewed-by: Reinette Chatre --- Not using Closes: since this patch only addresses some of the issues reported. arch/x86/kernel/cpu/resctrl/monitor.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff -- a/arch/x86/kernel/cpu/resctrl/monitor.c b/arch/x86/kernel/cpu/resctrl/monitor.c --- a/arch/x86/kernel/cpu/resctrl/monitor.c +++ b/arch/x86/kernel/cpu/resctrl/monitor.c @@ -30,15 +30,15 @@ struct rmid_entry { struct list_head list; }; -/** - * @rmid_free_lru A least recently used list of free RMIDs +/* + * @rmid_free_lru - A least recently used list of free RMIDs * These RMIDs are guaranteed to have an occupancy less than the * threshold occupancy */ static LIST_HEAD(rmid_free_lru); -/** - * @rmid_limbo_count count of currently unused but (potentially) +/* + * @rmid_limbo_count - count of currently unused but (potentially) * dirty RMIDs. * This counts RMIDs that no one is currently using but that * may have a occupancy value > resctrl_rmid_realloc_threshold. User can @@ -46,7 +46,7 @@ static LIST_HEAD(rmid_free_lru); */ static unsigned int rmid_limbo_count; -/** +/* * @rmid_entry - The entry in the limbo and free lists. */ static struct rmid_entry *rmid_ptrs;