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 A05F9C5478C for ; Wed, 28 Feb 2024 23:47:38 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id EC65E6B0083; Wed, 28 Feb 2024 18:47:37 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id E734B6B0088; Wed, 28 Feb 2024 18:47:37 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D62556B0092; Wed, 28 Feb 2024 18:47:37 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id C7AB36B0083 for ; Wed, 28 Feb 2024 18:47:37 -0500 (EST) Received: from smtpin15.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 6773DA11C0 for ; Wed, 28 Feb 2024 23:47:37 +0000 (UTC) X-FDA: 81842852154.15.D827544 Received: from sin.source.kernel.org (sin.source.kernel.org [145.40.73.55]) by imf04.hostedemail.com (Postfix) with ESMTP id 8123240009 for ; Wed, 28 Feb 2024 23:47:34 +0000 (UTC) Authentication-Results: imf04.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=HgrMVkqV; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf04.hostedemail.com: domain of djwong@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=djwong@kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1709164055; 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=gFin5Ha941pM+oTIpOjOj5tJgltVuH2dB/NW04guX2o=; b=P+5pnGnLKYEQgfBL5/DT1gXf/Wn+YBAqIHinCfZ10A3HCfDAVH8g69VlQiymexLcqnqLU9 iF3+m2KUqx1neTIdk0MnDHZ+e7QcwQs0KtHYhAF+m3mKo2m19FmYSoYabRvHbJga393VuM JN9STscUj3G410VKQvpQbelwLvvi4+g= ARC-Authentication-Results: i=1; imf04.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=HgrMVkqV; dmarc=pass (policy=none) header.from=kernel.org; spf=pass (imf04.hostedemail.com: domain of djwong@kernel.org designates 145.40.73.55 as permitted sender) smtp.mailfrom=djwong@kernel.org ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1709164055; a=rsa-sha256; cv=none; b=mou5bTq7pV5pAumN0xDxyBmlAvU5aqUV0IbsrXC2fXYmE2OyvwzkPdhWiT2iYeQT001Z+k nQEF9dVBoXzoNZYARTp7wAD+A3hJlQ0YmDt7ZBUpJ/ph1e/cgfKdhNY64QnTMd03IO9Cu3 BieYBZhqEbNPYzdDOAuzEpSOsxuL7MI= Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by sin.source.kernel.org (Postfix) with ESMTP id 99213CE22C4; Wed, 28 Feb 2024 23:47:29 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id C5A70C433C7; Wed, 28 Feb 2024 23:47:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1709164048; bh=CErcVwzK1TTHfc+m0Kbn7aeahlUqGCojo2q/jlVzhqc=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=HgrMVkqVf2a+dD1RNIhllUQsjsxhzphGxBkqyd49i8wBMQceR2efHWNzm8CXp0yXr a+tearMLudf9ijgv81CrO91RYvc8l1I2eUo3PB5myivkwL1yPvtfcLTj9v1cqzHlzH 36l/JXspeuE0kWNNN/J0lC5x4gUOPNGLjRNC1umHFQHr1zWbqxrmCYDdUrWCJ4XiJ7 ji1hpZla1IfvWJsUwXhAKbKigRmXfbbxI0XFDxqmu3KWqx02sE7kaZ4keC7g5xT8P0 HND1BJBlseRLVC/hG7lEaKTHs5G0T4DrjqhNRhPYJcwJxADxaCi2qZeoUtsMQEIupP I0pRxDe/GDNRA== Date: Wed, 28 Feb 2024 15:47:28 -0800 From: "Darrick J. Wong" To: Jonathan Corbet Cc: Akira Yokosawa , Chandan Babu R , Christoph Hellwig , Mauro Carvalho Chehab , Stephen Rothwell , Andrew Morton , linux-xfs@vger.kernel.org, linux-mm@kvack.org Subject: Re: [PATCH 1/2] kernel-doc: Add unary operator * to $type_param_ref Message-ID: <20240228234728.GW1927156@frogsfrogsfrogs> References: <878r34p60q.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <878r34p60q.fsf@meer.lwn.net> X-Rspam-User: X-Rspamd-Server: rspam12 X-Rspamd-Queue-Id: 8123240009 X-Stat-Signature: ict5tpi6k1oejh7mj3gckz7md9zuhgai X-HE-Tag: 1709164054-837403 X-HE-Meta: U2FsdGVkX1+Q7x/1V9omJ7Xwq4nfbX4pYwtVEUMD85jOdRjBb6JzHNs1ZAuAYc3MKT2eWNVGaj2uTcBkJs9IYAlUPYBUhUi/NwqM1rbpdcOWCMIufN3UBSiWDpxBo/7OgnAyciN2f+XIwSY+a5Q23G7o+GjDNnblyUGRI91JxJCAAy+9lAZPx7zqPDctqR7F84Je0fuX/gf9e/KlBA+K6yVmfdLBjvKVeB6ut0HckBsCyk1lQgJGZSC5AUZZqrURgNgrcCbgOAg44vOJBfr1HyXTnCG3Cs2vC0KP621Q1YwU4Oz5OsPy9Uy68gx5lrKkXSoFls4sr8kiL//BZo8+JELD19ye6H4LdA9weRmxk17aj16+OKYq31R+A7tzx9/72LBu7NBkwSsCVsKW5mbeBIA5NUQnT5Va3lDb/xdt6c/sDHIskAjmip9TrC5IQWc5r8Q4B6QaDwc+fQgQEjlA7b+qO/G4mi14hu2A5428lQjxRuOJjj07Q3PJMAVbNvGbZFsK4NSDN7VEtXX6/BaTuTgBYK4I29fo3uJCH45iv6WnmyhYyksLBlZqCDXMWuUQSSPxZsWaF/D1Xxyk/IFg0yQG521JUe4YAmj62xvzdndEBo5OfvuxeGcxOx1Mw4UDxypZxc/OEMDbiv9mTapz8uEABvf9XiHtfsiHqara5kHI8/IjxJGq5I4tiHPX8vPlgz5qVGwE0C3g0wFQqCo1nJ7TjRob091f2RQYdiGmfJTG/6GBVin/iIH/0VHQ6V28p49F1aFLZf9+8urg4UOf8wIBdplGXyF3X+A9TTp9gXOLTt7kZVt0nZb4ZbJYJdjsLySZQSP2tqbdAO/3pi4Czvbyhgmn6ZJYvvYUGDJ0Pzag9SSfcXIYsEO8nyDdEygIvCY57KcLY3h6bke2mZdcf03Dfm99djjW4YJi8nxtpec2w3lQpQZVnmzZTxTGZ+tIEIhPnlXmdfhy8npL0az gkEIsBKl iDoBQ 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 Wed, Feb 28, 2024 at 03:40:05PM -0700, Jonathan Corbet wrote: > 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 Seeing as the changes came through the XFS tree, I second the notion of pushing this via the xfs for-next. --D > Thanks, > > jon >