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 Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id CEC0CE7719A for ; Sat, 11 Jan 2025 13:19:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 0B9C36B007B; Sat, 11 Jan 2025 08:19:04 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 06B046B0082; Sat, 11 Jan 2025 08:19:04 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id E74A36B0083; Sat, 11 Jan 2025 08:19:03 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id C3AD16B007B for ; Sat, 11 Jan 2025 08:19:03 -0500 (EST) Received: from smtpin13.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay06.hostedemail.com (Postfix) with ESMTP id 332CEB0A75 for ; Sat, 11 Jan 2025 13:19:03 +0000 (UTC) X-FDA: 82995226566.13.87EE2F6 Received: from mail-wr1-f43.google.com (mail-wr1-f43.google.com [209.85.221.43]) by imf07.hostedemail.com (Postfix) with ESMTP id 1217F40005 for ; Sat, 11 Jan 2025 13:19:00 +0000 (UTC) Authentication-Results: imf07.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=PXTyXxjM; spf=pass (imf07.hostedemail.com: domain of andreyknvl@gmail.com designates 209.85.221.43 as permitted sender) smtp.mailfrom=andreyknvl@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1736601541; 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-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=NQ950WLlj0TBvIMK61SXRto978+YceITtIyuftoObTc=; b=6gDj+z/0Or0wuWvOuyTYljtjIGj5+LQo3n7yO9J2rANZhWsvayYOTqIHboR9TkKgLZxGMp NmoytO0T/pf3exCAxXivv7JAgFA1SvE246jFF8D6mCBQFgNeR2teGn/DI4Mu+6bGZdftZP cjZ4d1sF84SWhzqKnjz1TJThuHgwdgs= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1736601541; a=rsa-sha256; cv=none; b=gKWwGxXbzaLWaHF+/cWnPOhGNh056aS7mK41vxs+45um1JmE0nUsJZQXBtBMlHY4xhwFBv 7BQemPsOz4JQ2VLHtS/R/8xKKp/W66pGP2f2m+qfSzS+XPK/Jxk+CmttKBfWbI4yMDBt8Z TjWjdjhjxQsLXTiKmBsXmXoKI7Ny6/E= ARC-Authentication-Results: i=1; imf07.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=PXTyXxjM; spf=pass (imf07.hostedemail.com: domain of andreyknvl@gmail.com designates 209.85.221.43 as permitted sender) smtp.mailfrom=andreyknvl@gmail.com; dmarc=pass (policy=none) header.from=gmail.com Received: by mail-wr1-f43.google.com with SMTP id ffacd0b85a97d-385f07cd1a4so2313885f8f.1 for ; Sat, 11 Jan 2025 05:19:00 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1736601539; x=1737206339; darn=kvack.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=NQ950WLlj0TBvIMK61SXRto978+YceITtIyuftoObTc=; b=PXTyXxjMrCFilhyUou4mxcYJzXDdNC6ujCkt2tMRk9RHtUH619/FuD3EvpydUFu9ab obEQd9B2xGSieVTNf+q7GFmpotT436E/9kCvLHwNaDQvmwxQ513H5L7R0IJpFB4jQYOe lez3ciSyfOYRZql3QlDCbE7U6cRlxTkG6ieDQ9eGQWe9ItD+6r1dlArC/8paEkCQkJ/Z 928s0xDhvHvF7ohmktXsRX6xtOBFeKmun+iCapmXnrwoP+ql2dcWZwDoPsfKKC1vkadQ QwMDwgstJNeb6jFtT1g+hsWgu7g+Hw0oSg4vTa4klLYFUdkUakMhQF9yWT2uk4/lWMtW D7bA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1736601539; x=1737206339; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=NQ950WLlj0TBvIMK61SXRto978+YceITtIyuftoObTc=; b=M6hqx4ctEXpOZdWGfaatE5X0m8mdn6IJ95FVpXgN3rcB+UeKc20RPCVW4uGDUqjav2 TX7LFxTNQS2K3mhQAzZXupspfIgYHbAT7lo/wT2H3/UxNRyuI/jaEdwXIMSsDNzLqoxL c88iMkOlWVk0pOhvA7GIe4jlaxRYx5j1Rx0qxvH1Qv5OrZ7VyjzG3PCkQe/EzKA5wemw WI+eg4QVqUAAvgFATChxyGkTS79UcLCXbd8+IPITDcTdjubBKd9inPFJcLazKu2TbN6r wXnM44B/LYF5nrOvL16qKU5e0/gph1JBCiplNxmfaLrPHYQE34a6hWbgSl4xv2/qOMwd 1XXg== X-Gm-Message-State: AOJu0YyWNQGrw6iDaMB70kXfNAnufTctCwyqI9qE+b5L3BAR6m6fCKFx y+X81tPN3xYS4XmGmL5+jvLCcr9BanyWKdamaJCPzkJi980leDhMDUZzOddNFDYgOj+VtQOYizp 9RW6q84hSop4O4N0lJtKAKPMcYr4= X-Gm-Gg: ASbGncvau3hOerf4QsrXZddP9QDf7AAXmeA76+owKUh0U6Tzp+sPVqpAUsQuC1E7s+U SqJ4D4jH/kP3QWGVBAbVdX01X4OU7WftuhQU7Ujca X-Google-Smtp-Source: AGHT+IGthyL+PhQgj3Hlj2gyc3LrewSo9/anEg67GAs9Xgq88LIf18lN9m9M0iUbqcAvUWXouIVo4Ik0s5uWLqtWl90= X-Received: by 2002:a05:6000:712:b0:386:459f:67e0 with SMTP id ffacd0b85a97d-38a87304a47mr14921574f8f.21.1736601539309; Sat, 11 Jan 2025 05:18:59 -0800 (PST) MIME-Version: 1.0 References: <20250111063249.910975-1-rdunlap@infradead.org> In-Reply-To: <20250111063249.910975-1-rdunlap@infradead.org> From: Andrey Konovalov Date: Sat, 11 Jan 2025 14:18:48 +0100 X-Gm-Features: AbW1kvZV4f2eoVrTO-A_9JWr9GI6zUELEgGiQ3ZEOk5kb1EAhJPWvtc96tf99bM Message-ID: Subject: Re: [PATCH] kasan: use correct kernel-doc format To: Randy Dunlap Cc: linux-mm@kvack.org, Andrey Ryabinin , Alexander Potapenko , Dmitry Vyukov , Vincenzo Frascino , Andrew Morton , kasan-dev@googlegroups.com Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Rspamd-Queue-Id: 1217F40005 X-Rspam-User: X-Rspamd-Server: rspam07 X-Stat-Signature: 38fipzwg4fpk4mz9kxkxzdirwx87b7bo X-HE-Tag: 1736601540-876876 X-HE-Meta: U2FsdGVkX19lTKU0/+KGmUqo7J+0BoYt+/7GiW+2XQhy/OPJWBFWgXyNV2cYcTSdi8Ql8D6jzXEYYzy0PbdjYfB3Sh/H+36qI/is9nd9OInanGnSF3UcbWWyzW0NhBYyaAtu554cVyxXFExVbhRZxNqTwQF5xn0Fxv2fjtZNICxBsaG4okFZpMoHggow1gN09DpxBxV7H8jQ9nob+BgjgH0r4AnN0NuWCdbjx3ZQvMhINjEiXsviCgjET42YmLhYx5yYpcLtJc245v2y8nn12Pc/z3YGVyTs9ZN9W+ohA8qGmZ2WUf+YuhnhPKdn1QyaCtfA0erEArCo2JCv8smWBV+G733OpM6MM0x1reiS28mBzU0YazySnN/wxuYFgyM0sAeT0/zwPtDuoS2pkS1JCe/S9vPAPKMev1IhURaG+jAgZK+eyWI8f+PFOidJKzVUWb0hEVEcuTr/kbDpAqflQOUpcvZrMt7LnO+EieIpcD13f2rmNAWTnJu+xz0Q8+Iy3KIBBPPxHCJX6e3p2UWhgfmCoGhOoZneW+vNl1vMQfRJ1RCcxXEVde5quStZO4TupWvPIrNJhVH+3INcnd9yq/ENJ3GDNvfx/vkR2jQ4bRh2HEe4RdVruMg3nCXBDDONGGi3UZQt9sgB9dG7SvURQjWBNEPlD4ZtjqFlXUri987qGqQcDilM3PdB9ULhWjXRftQwLVrPZ7+o9DDWChUUHgzwmAoloUZxeoJ8jDLxxECaYbPMM+8Gmi8+Ex4OLd4Aw67GC2owNdhKiVqvw1baXfpSWvwt8dUjvCzCDCHagjZ6x4DqLU+UXlpfC2jln6Ktzy2H+oBBxlVicqPOMjjIaNfzTd0oFec+8WLUTkwdSmuhoM9XeGHYiz08JO+HdtDkhr1YwJ7Ygq5UB444z3QVHIAp+mZvZYuUIaEbMBm+N/w/OPRKrg1fnawkdJj7AH1+ABzpVrYt0XBC6nHuy0U H6ZBKSwj 91/OuULc+JUP9bX2UbWkDgt8WG4IcgxnO1mwbs0NOaX/ZC8bIbQgVwSjsaAY/0cCofqwPsNVkPpA/XSVlSq5Ztu3Jc1pqjfCdarwXd1VzFKDAwCHV6xj+o3utqaJdOdOgMH51vgUXP3neaY7LQNvIb9At/tWoQf/xOYElCmZkdyMAuf1mxKDCf+guSycbpfLag7kaq7T72s7tZhFb/eBD1yh/2fh/Pc/+KhyPYBxfZCxOZ5U6HVL8nZkVMoSZTvBD9ZQhNZOu1LZjj6XhHekLTKQ8R3JU+J13/55lAQCazAxHBfSKIzIbkV12b9scP4Dtpicj1/6GuJg3hQyA7+r733u2c9cVXdt2omLEpE7KRXx7ACAzrIoivA7Iv5umVbzY2UjPhK8yn4i8L6wNO3e7aV3wUAhauaiX3JRxyB/QMpmiwqSVrat2Ycru/QT+AE9RJk3RSZTETQi4FHzxUIuRmGH6W0/CCyBCS6GsD7mjDh2i2BibEgk1CabnATA+P5Li2/PpTAYfzjDymKcl4m4xCfdYjusXaw5oYxwgCfiD3qS+aCYA3wb33yDU8btmAhWeTgtx5t1N2fSxG4enoEmECSPxcVtEP1YFTaBsJH024YyZO1Zw2Uwu96KjRr7adGZ5tt/w+yDVhbTpQ4wJwIXgTYOtb3R/nn9AqIQHBe4jrp4p3/Q= 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: On Sat, Jan 11, 2025 at 7:32=E2=80=AFAM Randy Dunlap wrote: > > 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 desc= ribed in 'kasan_poison' > kasan.h:509: warning: Function parameter or struct member 'size' not desc= ribed in 'kasan_poison' > kasan.h:509: warning: Function parameter or struct member 'value' not des= cribed in 'kasan_poison' > kasan.h:509: warning: Function parameter or struct member 'init' not desc= ribed in 'kasan_poison' > kasan.h:522: warning: Function parameter or struct member 'addr' not desc= ribed in 'kasan_unpoison' > kasan.h:522: warning: Function parameter or struct member 'size' not desc= ribed in 'kasan_unpoison' > kasan.h:522: warning: Function parameter or struct member 'init' not desc= ribed in 'kasan_unpoison' > kasan.h:539: warning: Function parameter or struct member 'address' not d= escribed in 'kasan_poison_last_granule' > kasan.h:539: warning: Function parameter or struct member 'size' not desc= ribed 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 > --- > 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 onl= y mode > * that has partially poisoned memory granules. Reviewed-by: Andrey Konovalov Thank you!