From patchwork Mon Mar 22 12:25:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lukas Bulwahn X-Patchwork-Id: 12154685 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=-15.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, 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 191C1C433C1 for ; Mon, 22 Mar 2021 12:25:59 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id A8C9C6198D for ; Mon, 22 Mar 2021 12:25:58 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org A8C9C6198D Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 9F3AD6B00C1; Mon, 22 Mar 2021 08:07:07 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 9561C6B00C2; Mon, 22 Mar 2021 08:07:07 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 81DFE6B00C3; Mon, 22 Mar 2021 08:07:07 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0093.hostedemail.com [216.40.44.93]) by kanga.kvack.org (Postfix) with ESMTP id 60EE26B00C1 for ; Mon, 22 Mar 2021 08:07:07 -0400 (EDT) Received: from smtpin36.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay02.hostedemail.com (Postfix) with ESMTP id C87E352DA for ; Mon, 22 Mar 2021 12:25:57 +0000 (UTC) X-FDA: 77947431954.36.4BD2C0C Received: from mail-wr1-f49.google.com (mail-wr1-f49.google.com [209.85.221.49]) by imf30.hostedemail.com (Postfix) with ESMTP id 6AEB6E0011EE for ; Mon, 22 Mar 2021 12:25:57 +0000 (UTC) Received: by mail-wr1-f49.google.com with SMTP id z2so16490189wrl.5 for ; Mon, 22 Mar 2021 05:25:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=DGlVH/z6AUneSXkTaU6Us2MYmJ8DP9BEj41zBXWjRaQ=; b=CdLxL9vxfxfEOK8O/aRcklGoAV8Mq2DFTnxOY7sfTtalvMiNQ/htQ7igCwvrDISCeA ArlP0pV9zagkKMpgNskhO01r5IeiQdrC4quDzF9Hr8TEDQuqjobw1LmyMQFLCiL2OgeA PbJlgSardXEpxnvrLwrlLM6DGUen0+VRafPnPyKod5Fv47vvkV2a3+3CQqEMwmmzNild cI25enb9ZB/04vJv0lbifMOHyYc9rLxVK5eG8W/4uTYqIJOSx6jZZI8OqImBXH+Y9b7p whWL8hVFCyY9x/uJZ6MUjle+1cstP8JEuLhRk3lKtdcNEoz0ArEsm88SHOFyk7UcMstL 989w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=DGlVH/z6AUneSXkTaU6Us2MYmJ8DP9BEj41zBXWjRaQ=; b=G3SSs9asGhKMRMV0nCavZYUMkbmAuRLVpUjjhElJ8VCnM5KvB/DSsIM+2MY2x+S9t9 OoWl4euWG1Uj4uxYNUDTBRLPy8ukjBWK5eLRCxY0Cc04zQ6ciawJtVqpAgss7B8yE30q h+TyPjkCB/bdb7JLCGIbuGlikUf0RfIrHvUC8WWM5loJLhSlldMIdoJd0D6K36/w3YS5 bc4oFF7z/4YuHKw69KYwKuTrzNc4Zo7oEViahne0B+2RDcHih7b058p34FrgrpO2YcJE eqzmpYNDo0Q+eiD8lqk3u9C7l2UEBIqSVhmvdYa1q+4dSOwsFfZLwRrTWKvXRYKwiMPh 8CFQ== X-Gm-Message-State: AOAM530KrYan4Uqp6B/SbtP1nGy6nnrFACObvd65vsTgz8YaygZEYZVd pyfq4UkTtlhaC96fKz5VRMo= X-Google-Smtp-Source: ABdhPJw+eHBj2KVeDbm7TygBhjGJNoFQ+/Qn1A6XGoCBeSsem+1cwpXiWbSXFu2mbxJZFe7y6qxhVA== X-Received: by 2002:adf:ea8d:: with SMTP id s13mr17867999wrm.32.1616415956354; Mon, 22 Mar 2021 05:25:56 -0700 (PDT) Received: from felia.fritz.box ([2001:16b8:2d8a:8e00:5079:bba3:3b0:9023]) by smtp.gmail.com with ESMTPSA id u17sm19088558wrw.51.2021.03.22.05.25.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 22 Mar 2021 05:25:56 -0700 (PDT) From: Lukas Bulwahn To: Andrew Morton , linux-mm@kvack.org Cc: Joe Perches , Ralf Ramsauer , linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org, Lukas Bulwahn Subject: [PATCH 2/2] pagewalk: prefix struct kernel-doc descriptions Date: Mon, 22 Mar 2021 13:25:42 +0100 Message-Id: <20210322122542.15072-3-lukas.bulwahn@gmail.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210322122542.15072-1-lukas.bulwahn@gmail.com> References: <20210322122542.15072-1-lukas.bulwahn@gmail.com> X-Stat-Signature: 9yms64mego33i9aftncs4mnxmazkzozb X-Rspamd-Server: rspam01 X-Rspamd-Queue-Id: 6AEB6E0011EE Received-SPF: none (gmail.com>: No applicable sender policy available) receiver=imf30; identity=mailfrom; envelope-from=""; helo=mail-wr1-f49.google.com; client-ip=209.85.221.49 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1616415957-186248 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: The script './scripts/kernel-doc -none ./include/linux/pagewalk.h' reports: include/linux/pagewalk.h:37: warning: cannot understand function prototype: 'struct mm_walk_ops ' include/linux/pagewalk.h:85: warning: cannot understand function prototype: 'struct mm_walk ' A kernel-doc description for a structure requires to prefix the struct name with the keyword 'struct'. So, do that such that no further kernel-doc warnings are reported for this file. Signed-off-by: Lukas Bulwahn --- include/linux/pagewalk.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/linux/pagewalk.h b/include/linux/pagewalk.h index b1cb6b753abb..ac7b38ad5903 100644 --- a/include/linux/pagewalk.h +++ b/include/linux/pagewalk.h @@ -7,7 +7,7 @@ struct mm_walk; /** - * mm_walk_ops - callbacks for walk_page_range + * struct mm_walk_ops - callbacks for walk_page_range * @pgd_entry: if set, called for each non-empty PGD (top-level) entry * @p4d_entry: if set, called for each non-empty P4D entry * @pud_entry: if set, called for each non-empty PUD entry @@ -71,7 +71,7 @@ enum page_walk_action { }; /** - * mm_walk - walk_page_range data + * struct mm_walk - walk_page_range data * @ops: operation to call during the walk * @mm: mm_struct representing the target process of page table walk * @pgd: pointer to PGD; only valid with no_vma (otherwise set to NULL)