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 F3224C47DD9 for ; Wed, 28 Feb 2024 22:40:11 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 89CF46B009D; Wed, 28 Feb 2024 17:40:11 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 84CA26B009E; Wed, 28 Feb 2024 17:40:11 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 73B9A6B009F; Wed, 28 Feb 2024 17:40:11 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 64C1C6B009D for ; Wed, 28 Feb 2024 17:40:11 -0500 (EST) Received: from smtpin03.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 32EA51A0DEA for ; Wed, 28 Feb 2024 22:40:11 +0000 (UTC) X-FDA: 81842682222.03.556DFC4 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by imf27.hostedemail.com (Postfix) with ESMTP id 882704001A for ; Wed, 28 Feb 2024 22:40:08 +0000 (UTC) Authentication-Results: imf27.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=JwUltaEN; spf=pass (imf27.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net; dmarc=pass (policy=none) header.from=lwn.net ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1709160008; a=rsa-sha256; cv=none; b=p9O39kPSfN7PNYxymHr+0CI+g6R1JtyAtunEjGfXKAQO60WyKrjOWkKO/t9p/BZB6AU1Af rg0iVQvhW5afFJXQR0SgP/j67wtlDw12GZtJT+wwdYwxhakUglOujdWoqno5P7ijQQPH42 fr+53V6iKkxnRwL81e9BXAH05V75dow= ARC-Authentication-Results: i=1; imf27.hostedemail.com; dkim=pass header.d=lwn.net header.s=20201203 header.b=JwUltaEN; spf=pass (imf27.hostedemail.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net; dmarc=pass (policy=none) header.from=lwn.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1709160008; 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: in-reply-to:in-reply-to:references:references:dkim-signature; bh=FGNKmdc6dA/qTi4hpgJgh+dTTUy8sXGrpgo/mxNKHFQ=; b=7huvToLbwMW5dN8R3h5JqIygc2NrU53l7U0Hz7ybqffKQKIw8HtDGKYfuP60TOV/S7iRR7 UZGPyMdTeM9Zn/c0j+9UcZa46pckyU7zp2iQmSHG+AMpzV1Ml8STGkkPK/25wqoYFoOW1l bdqC+MyYxCboY3b3GeEZAmxicLs6dqA= DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 3C8A9418B5 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1709160006; bh=FGNKmdc6dA/qTi4hpgJgh+dTTUy8sXGrpgo/mxNKHFQ=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=JwUltaENPXq3/q1lZ0jpLpCFE4JhIWl5obZEVhRLuhpVlsp/ZwjG2jOkaPh93wGnB pdclby9NNIzvj2AoULeoTCQvWmTIT8sXXe0Hy3lXYpCGZhmr7nkXWXJTNu6gXksa1B ACyDvpEPlSa0T5n2+BxX6TIZZCgCS6gfukZcDdRLLetumvmlzxFu64mTixPZYM2ouF z1OckeC0uEdFE70aJaJggu4FKrOlyBq2EIoNB3UmoUCH7mKlW3vkVsXzXjfBuYIYnW RAMb/xJwXFWKow+hfF06KbnXc/GIlGO2o0ztvHEOAK5ZdSAUhPE80EWw6Oo7U5bqOY iCG80naGvXnMg== Received: from localhost (unknown [IPv6:2601:280:5e00:625::646]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 3C8A9418B5; Wed, 28 Feb 2024 22:40:06 +0000 (UTC) From: Jonathan Corbet To: Akira Yokosawa , Chandan Babu R , Christoph Hellwig Cc: Mauro Carvalho Chehab , Stephen Rothwell , Andrew Morton , linux-xfs@vger.kernel.org, linux-mm@kvack.org, Akira Yokosawa Subject: Re: [PATCH 1/2] kernel-doc: Add unary operator * to $type_param_ref In-Reply-To: References: Date: Wed, 28 Feb 2024 15:40:05 -0700 Message-ID: <878r34p60q.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain X-Rspamd-Server: rspam08 X-Rspamd-Queue-Id: 882704001A X-Stat-Signature: kft8xuqe4w51qog6rrmuygu7oaz8awgg X-Rspam-User: X-HE-Tag: 1709160008-903667 X-HE-Meta: U2FsdGVkX1+Cuac+2jmuVi3GeqCP+UJnQGZToFi9rSPOhkp4Hjbx1K1LXDQH76N/aDf0F5hI3vL9WL/+G0zmssbsHJZ1/Uk19+BA+NvjjvI3gHxIBfnymQnp+X0luN3MCPHOmFNZb1ECaD9m6c+7/vO8B6tDkX2pwBFSPKunXF/C6P4ydAiQSigUcm8/ILLpWGQME6NIVY6QK/OXN34ac63lfW2uGQv8GtBSwfZrYj1UlF7jll8L+QEZ7Eeo0IYopSJ4jhFvSLP/75K5BrTZqL2a3RofqT9BfzJ5sZQZNI0roGEG0JQ5LB76of1jtQxQEmIFNM+qm9eWWtiwuuThxAvSKbv0QiKZ2VWgZjbO5pkwZ3JhFkI45VeXkXLgelWmPsS4hEfTp4RYHi/sSB3ov754caA6XLbIk8UId3riLy2vacwvREpiSpPwkqYbt6M+KLXl+NNKS1GoPfDPmQk5YhqHvBwmaAjVlgxUjMimWFCEAgWqxR0YVZ8eMioa/eoUReJhN1jMLc/wDOPWcTyQ9zaVfVj/4Zm3IZSEhzomALXSiGWBOW6Fpf4i2eAls/j1zJVQuef3FbicLMS7eHPMiaZXKzZYP2Rey+Ugfbq8pvwKxvO1UXh9vfQR+UcY4KIT6ODPnB73RjzbSSBYBhjX/ziPYzeqbO1GD2Uk3VjiRXtJdVdJF8GZBLFOInSMX2uQomVF+8sNcEn4c6+BqLA7CcdcLc+/42UEMWvNEjyfDqeg8kM8bHL6OFSJqR34v2ekSpyF3Dw0fku+GdHvy8wzSxvqzyJfIR7HHdp2ou+AY6DfPFseCR+6nI663wUw2t0iAwjS6yupkykl5o1u44uoLorghTnKk2UFb4xnWx2HiffWhRAKxxfdOjaVPk/2FzJxlS52zCoW/fIperALkrO+ubrbEL9JOeJK42XhDlYwo+rlmgoOLbPIcm+E/M/+murEHmLwGzg3pqA1PKSDx3I ZuUe5I36 IKY/6e953pER4n8MRWxOuxkPs0Zftmsh9WJujkVLBOFD9vZayi0n8xP41kSarWL4DMQUtQ+qSUQa4TTYXMkPHm4Y/h7ViqqnqCSWB6Kd7v88dPKGgXLbjYQy2MptDD5f6Nnyty7l4GG482xHuO203dlsEAZkoBUMqm3bzf7O0vLykFjgTve5EK1sIgqk0r3loKjghWXCkbejE6Iod26ZrA4mPiyLc0Zqv3PKgkn0OlKan4L4jPsf41sdJrdAr4aIwvolTqLVsT89fRcmwg5EnYQR4edgOI2BIzUBIM+UZA4BLMh2gYoDCtj36bMubtAT5X2KvO8BGPsY839z9RiBzgIoHL1jYOuqftEPdraarw2jI6phLGqOgyRMPsNGkoWEoANRM8IlJK2DL5ihc6o2B9cfg/JHPmewYMyji49JN7mabxCrvmnapVe3a1lMyhJfGebfe 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: Akira Yokosawa writes: > 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 > --- > 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. This change seems fine to me; I can't make it break anything. I can't apply the mm patch, so either they both get picked up on the other side or we split them (which we could do, nothing would be any more broken that way). For the former case: Acked-by: Jonathan Corbet Thanks, jon