From patchwork Sat Jan 11 06:32:49 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 13935800 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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 94629E7719A for ; Sat, 11 Jan 2025 06:32:55 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 1F5096B0095; Sat, 11 Jan 2025 01:32:55 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 17CB36B0098; Sat, 11 Jan 2025 01:32:55 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 044696B0099; Sat, 11 Jan 2025 01:32:54 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id D2EFA6B0095 for ; Sat, 11 Jan 2025 01:32:54 -0500 (EST) Received: from smtpin14.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 2B8D91A0FA0 for ; Sat, 11 Jan 2025 06:32:54 +0000 (UTC) X-FDA: 82994203068.14.73258B0 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) by imf04.hostedemail.com (Postfix) with ESMTP id 3351940010 for ; Sat, 11 Jan 2025 06:32:51 +0000 (UTC) Authentication-Results: imf04.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=lJzKKNO3; spf=none (imf04.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=rdunlap@infradead.org; dmarc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1736577172; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:references:dkim-signature; bh=05H5Z13o7TdLJt+1ogERo0k0wR5JRvboTE8J3zcgdyM=; b=pdS+tBbqKTq5RN7vjagBF7LEX14VzQFxUtOZDRD5TCAXfvrgnbLeixlwqg+kkVyBy/h0Sf yXVnhOfbvtQM2l/7xuv8WHqZZ3cLeOeLxkaZA96o0zcXw1dnPNbBz2XaTGLgcm/96AkBl8 WjbpWlOxKgkFefFcfxEWUuh09DA+Mag= ARC-Authentication-Results: i=1; imf04.hostedemail.com; dkim=pass header.d=infradead.org header.s=bombadil.20210309 header.b=lJzKKNO3; spf=none (imf04.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 198.137.202.133) smtp.mailfrom=rdunlap@infradead.org; dmarc=none ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1736577172; a=rsa-sha256; cv=none; b=Z/Ob7KkgWKzOpcqnM902+8Rroy6NCBgi3Y6tHkPCu3fHdjflw7sUTt+Els6vWsFREgNnrm /WxG+92nTKZ450AL+BHcvk+NOZRBX4dx0/FwcWCN9gMrwIQaMrfGQgsG4fGmdT10bu4N6h Dkkbs5axSGUDvHvruEtKqlVE+vxfxo4= 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=05H5Z13o7TdLJt+1ogERo0k0wR5JRvboTE8J3zcgdyM=; b=lJzKKNO39/Ik4xf47HY3nd0lfg 3p1jraOLbmRYGDs9qMMiU5uzPaK3gtMtQCWrN+SCj0Re1gLNjjfLfxKC7qDv+ttnb5juieJmXe9Cc c5nX8gsOa5WVjePCH2EaEx2uQii/tMTat5Doy1uvWwDnXz9acTm9pxssSt9Gw+NB3NLoB3aqMvCcA e4bFPLhTnrifWvvoUqqNLtxSCmyxRvJ+yanQtNAEpKoZcRpsu9LigUi/H3gxYEzgLI5sl74Y4mrPh LI41IlttRP4uOLjTJoo0tqXeB5CeLgWP5AlI3XaiISm27UWTp0rPgEy2VNoiEGn0dbDAqFO4FagQq Th22NYvQ==; Received: from [50.53.2.24] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.98 #2 (Red Hat Linux)) id 1tWV3C-00000000Hwc-0F1N; Sat, 11 Jan 2025 06:32:50 +0000 From: Randy Dunlap To: linux-mm@kvack.org Cc: Randy Dunlap , Andrey Ryabinin , Alexander Potapenko , Andrey Konovalov , Dmitry Vyukov , Vincenzo Frascino , Andrew Morton , kasan-dev@googlegroups.com Subject: [PATCH] kasan: use correct kernel-doc format Date: Fri, 10 Jan 2025 22:32:49 -0800 Message-ID: <20250111063249.910975-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.47.1 MIME-Version: 1.0 X-Rspamd-Queue-Id: 3351940010 X-Stat-Signature: jbx46tfp9ra9y8cro1ypwqxasf1bxxr9 X-Rspam-User: X-Rspamd-Server: rspam11 X-HE-Tag: 1736577171-410500 X-HE-Meta: U2FsdGVkX1/TIGZRDKkLow63yoaKXepbNg5YnmtGKADrHFl/6XzJAwyGezc7zR+bi8gukLPTFauSRZuBAnUYDZUPYm8Qb/K6zcToq7U3EBwxM4rrXQL9/U5hXJbQWNUWsHZERD9neaDKXJ++DwLMBCbOb7iCOrq2CPJzgIU4bGcSSrVsKcb4S6cY7uB5PNWBEwFg/DqPp1grr8fM5TMOeSTGdqH+FW2/fHFH30j8sZ1kjiuuJvbkKNOhQ8i/J/K+tUIxm4datbr8J5Fj9HmeahIXzOUG7QBmj20CbvLdtqeNsu0+NFaoQOd9MZZ8bor8rJQnDfB0Vsi4tmjdviUiwg9wM1LeqXe3c6O/ngBbo5oSASfX5eWFgkoWbojSDi0tSZzMgulu9X8PzTUrElzb/QmsccTGQcXmn47aKnkB/ZP9S26j/4UEzc4vfIVc7Z2tf+h2UscjD1AUuG5BuGATmaE07Pk2RvMRHE87YFNR6SbAEemSo8phMGBvPWsZpGdzADw5r0THOk67BOcyoHUPSpgJihylN2UMWELl0I9eBvtf7cj53U/nlbvORErmvstdoFfZZNtZgU2P4PuzI2hmJYVYDpgGC8GAmNbsPsqI9tDHaeLUhWtldxYh07pt4/8ZMsSp4HZNHMSKqdHLmfSmHmhrN/HSfW5RcoekhHf7FUdY10KCMyW8XUYfIGqm9QvKZPgQ/0YLG6xDP2tk2HAn1WuDkNN9NrFyjMTlxJ5n/K4AyaFlLSxicV6FfBs2iy5vfFeucN497BuUlYAl3g8b0uiEtKATruttHAZOloR4Npv9Su3q93GSryjRAxxrWJYJj3wCbuG0gOENR1AvYmVuuAmr4ZgiDp27ee8JycaW6udIkH1VkvbShuxdx9ByIIf7IopkLHu3WvVK8YEMvfDA+qHvJMVJ/LkDV5H1O3DELxab4nNPtljn7671hm84nH3gnc3qMUaPdnkb+fqKVfa QRkkycKp UTFCCvnyZUQS1cRVdcznwdihtrpnUN6ge+paUrIOO5JJty6ZBdiiPUPrQsxguYzXRMu20U+svjltJAEE1AR7lwfvoKaCJRk9Q+JGWvl02UToZjR/ZFrSjMmS1VylyrcXzoWYGnngD38ZP1H9LqsvbqAIX7DEJBpD+ngLL491aJRumkBfDl9vwPvfQt0AZG0cgKy8ZECGpalzx6+JzIQ0PWR7NDMpAFRTwm7Ti6Q3p6m96AXY/FEq2JSwWoyIWTTDHFSagfauvGDQkIoHZP4ADYXGR1NZgw/f6sv3gVHgYzXkGIpMu4mE4Nzx9+vVRGN2Z82G0oC/J6GyO7ljGgQfAfV8GiuP1wkDyK+f73p/s3qH71uU7RxTei/5ghxXRcsOTCVJNX7gToYAEDN0PzJdRXyzxooNCEQQf7lPRhtoLjbDFSPd2rvjKwVMDK78h9uA0D0gBE8Zmads5WKtprf+67dZkOS2bqAef/Df+yhtyZYb4uTh/RdpMczPxU/kDp248DGEGVehzgunUe5Mr7ucF/Y/9LnDKBDKsG3JZ64HanAH+G60kv0pBZTdHv7+//D4UBLJRiZV0kmnAqvw= 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: List-Subscribe: List-Unsubscribe: Use the correct kernel-doc character following function parameters or struct members (':' instead of '-') to eliminate kernel-doc warnings. kasan.h:509: warning: Function parameter or struct member 'addr' not described in 'kasan_poison' kasan.h:509: warning: Function parameter or struct member 'size' not described in 'kasan_poison' kasan.h:509: warning: Function parameter or struct member 'value' not described in 'kasan_poison' kasan.h:509: warning: Function parameter or struct member 'init' not described in 'kasan_poison' kasan.h:522: warning: Function parameter or struct member 'addr' not described in 'kasan_unpoison' kasan.h:522: warning: Function parameter or struct member 'size' not described in 'kasan_unpoison' kasan.h:522: warning: Function parameter or struct member 'init' not described in 'kasan_unpoison' kasan.h:539: warning: Function parameter or struct member 'address' not described in 'kasan_poison_last_granule' kasan.h:539: warning: Function parameter or struct member 'size' not described in 'kasan_poison_last_granule' Signed-off-by: Randy Dunlap Cc: Andrey Ryabinin Cc: Alexander Potapenko Cc: Andrey Konovalov Cc: Dmitry Vyukov Cc: Vincenzo Frascino Cc: Andrew Morton Cc: kasan-dev@googlegroups.com Reviewed-by: Andrey Konovalov --- mm/kasan/kasan.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) --- linux-next-20250108.orig/mm/kasan/kasan.h +++ linux-next-20250108/mm/kasan/kasan.h @@ -501,18 +501,18 @@ static inline bool kasan_byte_accessible /** * kasan_poison - mark the memory range as inaccessible - * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE - * @size - range size, must be aligned to KASAN_GRANULE_SIZE - * @value - value that's written to metadata for the range - * @init - whether to initialize the memory range (only for hardware tag-based) + * @addr: range start address, must be aligned to KASAN_GRANULE_SIZE + * @size: range size, must be aligned to KASAN_GRANULE_SIZE + * @value: value that's written to metadata for the range + * @init: whether to initialize the memory range (only for hardware tag-based) */ void kasan_poison(const void *addr, size_t size, u8 value, bool init); /** * kasan_unpoison - mark the memory range as accessible - * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE - * @size - range size, can be unaligned - * @init - whether to initialize the memory range (only for hardware tag-based) + * @addr: range start address, must be aligned to KASAN_GRANULE_SIZE + * @size: range size, can be unaligned + * @init: whether to initialize the memory range (only for hardware tag-based) * * For the tag-based modes, the @size gets aligned to KASAN_GRANULE_SIZE before * marking the range. @@ -530,8 +530,8 @@ bool kasan_byte_accessible(const void *a /** * kasan_poison_last_granule - mark the last granule of the memory range as * inaccessible - * @addr - range start address, must be aligned to KASAN_GRANULE_SIZE - * @size - range size + * @address: range start address, must be aligned to KASAN_GRANULE_SIZE + * @size: range size * * This function is only available for the generic mode, as it's the only mode * that has partially poisoned memory granules.