From mboxrd@z Thu Jan 1 00:00:00 1970 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=-10.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,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 53C35C433DB for ; Mon, 22 Mar 2021 12:25:54 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id E45316198E for ; Mon, 22 Mar 2021 12:25:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org E45316198E 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 97E266B00B8; Mon, 22 Mar 2021 08:07:02 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 92D6F6B00BB; Mon, 22 Mar 2021 08:07:02 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 7A6A26B00BD; Mon, 22 Mar 2021 08:07:02 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0221.hostedemail.com [216.40.44.221]) by kanga.kvack.org (Postfix) with ESMTP id 5ECE26B00B8 for ; Mon, 22 Mar 2021 08:07:02 -0400 (EDT) Received: from smtpin03.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id C1F83180442DA for ; Mon, 22 Mar 2021 12:25:52 +0000 (UTC) X-FDA: 77947431744.03.9BADBA4 Received: from mail-wm1-f53.google.com (mail-wm1-f53.google.com [209.85.128.53]) by imf09.hostedemail.com (Postfix) with ESMTP id 563A56000102 for ; Mon, 22 Mar 2021 12:25:52 +0000 (UTC) Received: by mail-wm1-f53.google.com with SMTP id r10-20020a05600c35cab029010c946c95easo9136767wmq.4 for ; Mon, 22 Mar 2021 05:25:52 -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; bh=LOMTMUV/x85LsCPs4gPFUtmz8oNiKQ4g1MCpJALdrNc=; b=h23X+iafnBgO3cnGvZfeiDg84UGZYLcGqxh1D7fZNVic8vdWLnIQPRMVK42ZPf8o9N +K26B+14EB/6s0m9osJUsNjYzpbDuRf/7piB9JM4/q/UzSPB/U96FdLPbGlTUpPGvzOw 1hWUG56Xt4gBGdWCQOoAREVM2ewYnA0y6TVzNc+Q9mrB7CaQJrCObm8phOzqeAfJWR4p v2mbPrgNEOYDbzbt7Uw7F9RZUBTMzbr175Orz62+zqqqrEBfYgpc24vLlP1F8YafQ7A4 DtnwAxRPtNvi9UitVE2DyIcFIDEGhwT9Qsh+ZsSjRXHvV38GxS1sMiiu/mHnCcrOVCyn tehg== 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; bh=LOMTMUV/x85LsCPs4gPFUtmz8oNiKQ4g1MCpJALdrNc=; b=F1OTd4Os2YjUyUoezDZHPL3fTqojzobDpqgLUmQL5GSAHdD3217TAt6eslSli9ZXq8 8L+b3VdjRJ8gWcX1EN1bh1xoHX2JjjZkZcqv04icRKE0DYyVw0PHbJ8n18x+nVY92dLh fjg2MXlE2zvJi0mJJaGLgjisHT3BBVpwm03Jdw1yoUwVyr3TqIhOggW1uTimxSi9eeRu AeWhDdkkP4jR4aL22ZnEigXpqw5Oyg25dYEw5W5g0OZZasHKyJeL7rC+LW8B40wipI/r sxeoR/sp1c4xgtiiRVRtXYII5fvQyZCl7tc00CSBcd+Wl6CLHaaHlqhRkhzmpwcTb0sN Yzvg== X-Gm-Message-State: AOAM530xWiO4yGSdH2r/PpKev5ILsVg5AnX6hthptmuLMWkjx/txti1x BQ+rfqmcrK6LteT0FjY9gNs= X-Google-Smtp-Source: ABdhPJzt258rnp+NSla7apvIQE3tvvBvTpjWmYXSMVgriDFOrOqXSTatqWQQ26RLdAxRvgCu6jDioQ== X-Received: by 2002:a05:600c:290b:: with SMTP id i11mr16282819wmd.129.1616415950882; Mon, 22 Mar 2021 05:25:50 -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.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 22 Mar 2021 05:25:50 -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 0/2] kernel-doc and MAINTAINERS clean-up Date: Mon, 22 Mar 2021 13:25:40 +0100 Message-Id: <20210322122542.15072-1-lukas.bulwahn@gmail.com> X-Mailer: git-send-email 2.17.1 X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: 563A56000102 X-Stat-Signature: ugqxd7u95p75esap7ch7sz8hmz4qpdop Received-SPF: none (gmail.com>: No applicable sender policy available) receiver=imf09; identity=mailfrom; envelope-from=""; helo=mail-wm1-f53.google.com; client-ip=209.85.128.53 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1616415952-635235 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: Roughly 900 warnings of about 21.000 kernel-doc warnings in the kernel tree warn with 'cannot understand function prototype:', i.e., the kernel-doc parser cannot parse the function's signature. The majority, about 600 cases of those, are just struct definitions following the kernel-doc description. Further, spot-check investigations suggest that the authors of the specific kernel-doc descriptions simply were not aware that the general format for a kernel-doc description for a structure requires to prefix the struct name with the keyword 'struct', as in 'struct struct_name - Brief description.'. Details on kernel-doc are at the Link below. Without the struct keyword, kernel-doc does not check if the kernel-doc description fits to the actual struct definition in the source code. Fortunately, in roughly a quarter of these cases, the kernel-doc description is actually complete wrt. its corresponding struct definition. So, the trivial change adding the struct keyword will allow us to keep the kernel-doc descriptions more consistent for future changes, by checking for new kernel-doc warnings. Also, some of the files in ./include/ are not assigned to a specific MAINTAINERS section and hence have no dedicated maintainer. So, if needed, the files in ./include/ are also assigned to the fitting MAINTAINERS section, as I need to identify whom to send the clean-up patch anyway. Here is the change from this kernel-doc janitorial work in the ./include/ directory for MEMORY MANAGEMENT. Andrew, please pick this clean-up patch series for mm. Link: https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html Lukas Bulwahn (2): MAINTAINERS: assign pagewalk.h to MEMORY MANAGEMENT pagewalk: prefix struct kernel-doc descriptions MAINTAINERS | 1 + include/linux/pagewalk.h | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) -- 2.17.1