From patchwork Sun Aug 8 20:31:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 12425101 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D8C21C4338F for ; Sun, 8 Aug 2021 20:31:58 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 3CD0560F38 for ; Sun, 8 Aug 2021 20:31:58 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 3CD0560F38 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=kvack.org Received: by kanga.kvack.org (Postfix) id 5FAB06B006C; Sun, 8 Aug 2021 16:31:57 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 55C358D0002; Sun, 8 Aug 2021 16:31:57 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 424108D0001; Sun, 8 Aug 2021 16:31:57 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0100.hostedemail.com [216.40.44.100]) by kanga.kvack.org (Postfix) with ESMTP id 288146B006C for ; Sun, 8 Aug 2021 16:31:57 -0400 (EDT) Received: from smtpin10.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id A4A3418045E93 for ; Sun, 8 Aug 2021 20:31:56 +0000 (UTC) X-FDA: 78453059832.10.EB827BB Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by imf25.hostedemail.com (Postfix) with ESMTP id 7A9B0B007B7B for ; Sun, 8 Aug 2021 20:31:55 +0000 (UTC) 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=zzg1CwWQ21E2Hgrl1ioaa4QEG+Eakv0wh062e/tPBwg=; b=FCAJVnZQoEBW01cwnM5Rx8yJXM 59EvTn+QEVHHJR7OpOtFGYiFEQHCK9S4rPJtS3dd1U6KFieK/54v7pmw7dNSraHUPqYg0H5HTg6FH JKendnS7kaZX6SmgXO2eLwlB3iEiDcQ1KX+jjcLhM/EIqgSPLJxCrL2X6N/sHrFKUTMeBa4i/Qev4 M9+a+nDdb34DqBG5bmyj32bgKGCNxpwOB45wns1r4MP7ITDtJiNdsczRt9K2TBwmsdrSTwIzrQkt8 zWVliZ4hEgxJY8DdPGmq0seuBkSFJUVQ8/gILeriqko00yJlYNd14szkbsOXhdfi2R/K9iD2RRx0C WqjDCCvA==; Received: from [2601:1c0:6280:3f0::aa0b] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1mCpSc-00GSAP-Bl; Sun, 08 Aug 2021 20:31:54 +0000 From: Randy Dunlap To: linux-mm@kvack.org Cc: Randy Dunlap , Matthew Wilcox , Andrew Morton Subject: [PATCH] mm/workingset: correct kernel-doc notations Date: Sun, 8 Aug 2021 13:31:53 -0700 Message-Id: <20210808203153.10678-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Authentication-Results: imf25.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=FCAJVnZQ; spf=none (imf25.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=rdunlap@infradead.org; dmarc=none X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 7A9B0B007B7B X-Stat-Signature: z195ya3q795pnzhnt9gyf37yicjxkgfc X-HE-Tag: 1628454715-867814 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Use the documented kernel-doc format to prevent kernel-doc warnings. mm/workingset.c:256: warning: No description found for return value of 'workingset_eviction' mm/workingset.c:285: warning: Function parameter or member 'folio' not described in 'workingset_refault' mm/workingset.c:285: warning: Excess function parameter 'page' description in 'workingset_refault' Signed-off-by: Randy Dunlap Cc: Matthew Wilcox (Oracle) Cc: Andrew Morton --- mm/workingset.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) --- linux-next-20210806.orig/mm/workingset.c +++ linux-next-20210806/mm/workingset.c @@ -249,7 +249,7 @@ void workingset_age_nonresident(struct l * @target_memcg: the cgroup that is causing the reclaim * @page: the page being evicted * - * Returns a shadow entry to be stored in @page->mapping->i_pages in place + * Return: a shadow entry to be stored in @page->mapping->i_pages in place * of the evicted @page so that a later refault can be detected. */ void *workingset_eviction(struct page *page, struct mem_cgroup *target_memcg) @@ -274,7 +274,7 @@ void *workingset_eviction(struct page *p /** * workingset_refault - evaluate the refault of a previously evicted folio - * @page: the freshly allocated replacement folio + * @folio: the freshly allocated replacement folio * @shadow: shadow entry of the evicted folio * * Calculates and evaluates the refault distance of the previously