From patchwork Tue Feb 27 05:03:30 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Akira Yokosawa X-Patchwork-Id: 13573263 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 5BAD5C54798 for ; Tue, 27 Feb 2024 05:03:36 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 75DE84401E7; Tue, 27 Feb 2024 00:03:35 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 70D3B44017F; Tue, 27 Feb 2024 00:03:35 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 5D4F24401E7; Tue, 27 Feb 2024 00:03:35 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 499AC44017F for ; Tue, 27 Feb 2024 00:03:35 -0500 (EST) Received: from smtpin12.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id DBBEBA0AAC for ; Tue, 27 Feb 2024 05:03:34 +0000 (UTC) X-FDA: 81836390748.12.9A5ECC5 Received: from mail-pl1-f175.google.com (mail-pl1-f175.google.com [209.85.214.175]) by imf10.hostedemail.com (Postfix) with ESMTP id 0A6F8C0005 for ; Tue, 27 Feb 2024 05:03:32 +0000 (UTC) Authentication-Results: imf10.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=aPv5X7c3; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf10.hostedemail.com: domain of akiyks@gmail.com designates 209.85.214.175 as permitted sender) smtp.mailfrom=akiyks@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1709010213; 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: references:dkim-signature; bh=J7lxZ6ZnnW6n/tjC6roqqfxmo0+YlzqNpcqImIIdj+c=; b=gyQADWEPksDV6LgJDsNphcSSnjEiEhymSb0Kfb/9+aWKMYUq3FjCEEo6IN3jSeKIjTYxWd yemvoEedhQMcG0IeiapGajD7qH/aCHTpHNgOLC4mUfFjTSTw0vnIJRvcKz3Ckih8aAYpGB jAceDGhrgZ5KcoNlBCPMmycyAsp9hZc= ARC-Authentication-Results: i=1; imf10.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=aPv5X7c3; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf10.hostedemail.com: domain of akiyks@gmail.com designates 209.85.214.175 as permitted sender) smtp.mailfrom=akiyks@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1709010213; a=rsa-sha256; cv=none; b=jNA3dD9ORxRncZxWUPo2GbAK/L5P+ohUw62M+nM1Hk3WoQDAhH9Iycas/Dn0rgwtIQTSPF a6ag7SkaMDwqQSaco8JcEW4v//YTWxv8OzlnuZivMjM8XG8UZ3sbYmmbPgOIM/q23OhKyS mGd2ZRNaSRRW3gFdFM1EJZdl5MnAb6E= Received: by mail-pl1-f175.google.com with SMTP id d9443c01a7336-1dc1e7c0e29so18138975ad.1 for ; Mon, 26 Feb 2024 21:03:32 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1709010212; x=1709615012; darn=kvack.org; h=content-transfer-encoding:cc:subject:from:to:content-language :user-agent:mime-version:date:message-id:from:to:cc:subject:date :message-id:reply-to; bh=J7lxZ6ZnnW6n/tjC6roqqfxmo0+YlzqNpcqImIIdj+c=; b=aPv5X7c3WZgOSCeLedNzn2JKvadI268NsqXzGyQd3ubCfpiaOEcMWY76BTPH6q3LJ6 nAHFRlGDqG1x+uXtWumyuZl/P0aD0vYngehpIYnpSWqKRlSdGnsPdY8SKDfWqfdr4IGU QkMaKK1P9Y5DmOVEsUyMFMSS/Fblj4UOdpMNk6r9qqArzDTr7/1tHQWNJW0RPLtUFCRI eq447ubFzgiblZS40f3fvIdQPfRSXLyn+tRJp+AdwcZAsbMLHI3o2valTSpTb+G4XAYb aD7vpQde1KlIsmLCRbIFRgNN4UmG/SV2ZWHYRV/pMopaF+RrMajPbfRpjzXE9GRTyJXa gsNA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709010212; x=1709615012; h=content-transfer-encoding:cc:subject:from:to:content-language :user-agent:mime-version:date:message-id:x-gm-message-state:from:to :cc:subject:date:message-id:reply-to; bh=J7lxZ6ZnnW6n/tjC6roqqfxmo0+YlzqNpcqImIIdj+c=; b=iGQIcIwCuPeMHGrPfiy0NLy/YYz085xJ+vQ1YQvcBa4Jx73I8j4SBvZEZT1+HoUQZ6 5D8aqSkvG1hX0qChZxhe7FKxlVOgiuyrQDytrgpU5Wzc7hFWYcE68oT4Q3NPGbOl1v1C Vaqi8UteO8Wo0BkHfcDcTI9FpmTD0GnwHE/77g8WWOlg1SnFXnGAKijPYdl9l9LChdSo cfLFX35WxNARxQBxA9nwRW8muEW5GHmPQfsoxN6Cza/SLLuql7+eq3cZOKfy0M0IM/4u WM5gjhWibDBZvyBMc6M7p1QC5kkMRo+CitGjTpRjUm/62n4Ip6rjfjLIGPd5mIlcAVD1 zY3A== X-Forwarded-Encrypted: i=1; AJvYcCUCLcSg/yVx/QX0TRm/5fbOekwNHSvMMjXfb9Dl3TJUCah4JY0iO68THknL1NUhiyRaNu1BFE/ibzO4NjPoYOaBCNQ= X-Gm-Message-State: AOJu0YyqYsARnbfU7FFS29qJwEpVgGpsLb10bw8tlhnL3q0OaPE82lsk tnaQXPDuTL4jGEm7nbpJrhgCTj93mgYEAOcXHCgFYGYGzWvjFIGe X-Google-Smtp-Source: AGHT+IHF3Sse7HlMV0zt3tUexnG7qsxjE7Rl6h2yQNqySiEn6dP67CJ1ebFwKXg6WOYXqM+h1QHecA== X-Received: by 2002:a17:902:eccb:b0:1dc:a282:365f with SMTP id a11-20020a170902eccb00b001dca282365fmr5258126plh.40.1709010211660; Mon, 26 Feb 2024 21:03:31 -0800 (PST) Received: from [10.0.2.15] (KD106167171201.ppp-bb.dion.ne.jp. [106.167.171.201]) by smtp.gmail.com with ESMTPSA id kw4-20020a170902f90400b001db67377e8dsm537447plb.248.2024.02.26.21.03.29 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 26 Feb 2024 21:03:31 -0800 (PST) Message-ID: Date: Tue, 27 Feb 2024 14:03:30 +0900 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Content-Language: en-US To: Chandan Babu R , Christoph Hellwig From: Akira Yokosawa Subject: [PATCH 1/2] kernel-doc: Add unary operator * to $type_param_ref Cc: Jonathan Corbet , Mauro Carvalho Chehab , Stephen Rothwell , Andrew Morton , linux-xfs@vger.kernel.org, linux-mm@kvack.org, Akira Yokosawa X-Rspamd-Queue-Id: 0A6F8C0005 X-Rspam-User: X-Rspamd-Server: rspam04 X-Stat-Signature: dduyhm8gkasaymj7wnw1nkmb5x4qtyof X-HE-Tag: 1709010212-697043 X-HE-Meta: U2FsdGVkX1+c4soTqt3CwlCSgECJeJrLSRkgQedtgTJPYoZmGGtMc111Zb9yU+oY/0OKZ8+Sh5CwmMb8UCXUUcwVcEh3GKNiWgivQvyem89ZoWVnJP8KDcezXs6fC3K+/x/iSam7DUOlOGnai8lw2kMm1SRKScqTEs9SNdvreTNLlnWHPuaMc7rW61G9ylv80b2WVV/ua49GeogWmM5oYYMVsVjoxAsI0YlLf0B44TlpUpn6b85LAR5A+rTDhgk3J26WgU31+CarDLOhKCfENHZXvNDkaBE9KgpOwYBcr8AfBKvM8dCjdvtTYw0ARHc/OgzvAGfzg4HCel/KtZ73RVilE7lqWwvxY/cPs6+vpAE357uiEJgCozKAqzkDwN7rmqBuNwQmoWXmh2lHaUECYCUzC08l4OURdSZelDWvVqV5ir0O2x/cl49QbKN55GtnccN01Odx6EPMRcSCh03C/o+uE/mBBFl1Dnq1yM1zV1MbQqFWCs6qYBs0EOh4aYg5lEwtLnVSVISyxzzA3QK81BT1mHqBvD5ujaLuGvfXDJeOtDeF/pgfRWPmQu1vnSl5ohzZHS2hH4+n3wbngpgnnoPwMPGk1iZRZuBgQkLan2emzhjLrrUcvaw3o4t4cnSbmxl9JcAV/62CocFswbh5MHnkwpfOSQK3enqBfD4uS+47Cvd195zgKa42GxrhHr58wRq0aPwnsluiM+xY5JRiYASIX+AgiqQyDleRO+ghf3zSUiXwI2C4zUI1Ar4aVuDpZhJCHo6GnKMK076Ye9FUHapy4wewwB/0gyA2iRGsBy4K8S8NUpj0KjLJv/AdoCIGAiAOxZ4ojt7Md1VfbtUEesYaqnl6jZ4yUawhUAwXQjK90+HZ45znHvFhiJ3elIr4kS6jJKpplwUvXCkGceK4QufMJBRPyrFqDVhqywu2W/IQNZSRKXa0yA8A2TFVAvz5J+xwK6Z+mUlbOmokz0c uQScnP6y R4K2NDI2fDoll/2s37dPkY/WhGrzyVuP9DnhJ5BuyEDa+be529hA+HDYdMBbpv92AIeTh15HmOWsXLPiaOTtn7IFV111NmzujFQ5rmc5TNW6XybPWkFwp2+I1xYxtnZ/IonLMQer6BahuD7VHNVBLbVQ9eKe6xq9pU3g6Gch6YmUw2cOu/95nhQqv1LlU44DDq9bg0i+Fv3zDjRAxuuqdFjuhaaGjO/fsxvOaGjV+b75qAKaXqWB2qvRbvPzppC5wg+MRZj3R/QxG2wryhWuDwz5R5H0sJhB1zGpDoSMEjrkhvakfl5Vio7qTmB8C+nvrW+//uA4yRQ8012cZ0H9X3SgM0hZP4u3cnMPQJoMFqxCARyYcrwQG4lNw88vCWuenqXJxAnRzNrueuYTvO61lQCZGc6WK1OooEPKTGsgrPuTkVYOB0lJK+rZwSuaHlC6TNhK1qtz5Iqv4eTu8dw4QG9UkN+6PXB7kObHgkguEsZJ4fAevHo5iJh4sL6HP2KeCNPjA1Cx2TckdRl2CrRnKFVVOZpo+9IB2iy/ql/lehUFivT5rzApskl3pAwCNWyXeXuiYeAzTbGtbpEarD2tr3soB6jD2FUppE6QJy4gFPhIJJckWXULmaKNc69oSH2ON4rRv8R90evrRv/pe4fg6S87nAj/KkyTfvHBsH7xDcX1ESXK96o7+OSQKn/4fnahOCFmTsF7vyLn8mJj+DNIIhY9klO9M588hbHpp3ZtTHuWGAKDNAqn/KzuhHycu841nk8Yk 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: In kernel-doc comments, unary operator * collides with Sphinx/ docutil's markdown for emphasizing. This resulted in additional warnings from "make htmldocs": WARNING: Inline emphasis start-string without end-string. , as reported recently [1]. Those have been worked around either by escaping * (like \*param) or by using inline-literal form of ``*param``, both of which are specific to Sphinx/docutils. Such workarounds are against the kenrel-doc's ideal and should better be avoided. Instead, add "*" to the list of unary operators kernel-doc recognizes and make the form of *@param available in kernel-doc comments. Reported-by: Stephen Rothwell Link: [1] https://lore.kernel.org/r/20240223153636.41358be5@canb.auug.org.au/ Acked-by: Christoph Hellwig Signed-off-by: Akira Yokosawa Cc: Jonathan Corbet Cc: Mauro Carvalho Chehab Acked-by: Jonathan Corbet --- Note for Chandan As both of patches 1/2 and 2/2 are needed to resolve the warning from Sphinx which commit d7468609ee0f ("shmem: export shmem_get_folio") in the xfs tree introduced, I'd like you to pick them up. Thanks, Akira --- scripts/kernel-doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) base-commit: 4b2f459d86252619448455013f581836c8b1b7da diff --git a/scripts/kernel-doc b/scripts/kernel-doc index e8aefd258a29..d2f3fa3505c6 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -64,7 +64,7 @@ my $type_constant = '\b``([^\`]+)``\b'; my $type_constant2 = '\%([-_\w]+)'; my $type_func = '(\w+)\(\)'; my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; -my $type_param_ref = '([\!~]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; +my $type_param_ref = '([\!~\*]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; my $type_fp_param = '\@(\w+)\(\)'; # Special RST handling for func ptr params my $type_fp_param2 = '\@(\w+->\S+)\(\)'; # Special RST handling for structs with func ptr params my $type_env = '(\$\w+)';