From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-6.0 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=unavailable autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 560597D918 for ; Wed, 27 Mar 2019 05:20:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1732747AbfC0FSp (ORCPT ); Wed, 27 Mar 2019 01:18:45 -0400 Received: from out3-smtp.messagingengine.com ([66.111.4.27]:50913 "EHLO out3-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725805AbfC0FSp (ORCPT ); Wed, 27 Mar 2019 01:18:45 -0400 Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailout.nyi.internal (Postfix) with ESMTP id E6135220A4; Wed, 27 Mar 2019 01:18:43 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute3.internal (MEProxy); Wed, 27 Mar 2019 01:18:43 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:date:from :in-reply-to:message-id:mime-version:references:subject:to :x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; bh=MkHDjnuhQa7s6Nb5SWdLKYFJ84x4dIRVbvit8loBXBQ=; b=08M1pU/1 4POsaDnoDOopBtt408XVAK8R0nfhzbOqHfhuvHOvRXH+VWZy79GuVtSR+41yQVi9 bLrGLFS95qZ35OL3q0x8kaXEJ5KxG1IYtNZiEqDshmmbR0eoXa3YV9bnZhKCrPfB nS3d3z+WZ+Ew7qa9iqIuIxTg7knq0cVKA+vTLhvnsWYkc3EV0IrKUNPYRov8yq64 LpjoKVqKNHLOtNaSxcvlgM6uq09NOZo86BFEQmLofp4OvfPNdyyHvyF6rE+6KETV NYgHxpMtFJ/3q5Z7WSkkbOQSvsor/dceUSUdm42I4QO1GM5wjtpKiegh6eGCY42m a45p/XYaBRp/XQ== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedutddrkedugdektdcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepfdfvohgsihhn ucevrdcujfgrrhguihhnghdfuceothhosghinheskhgvrhhnvghlrdhorhhgqeenucfkph epuddvgedrudeiledrudefledrudelvdenucfrrghrrghmpehmrghilhhfrhhomhepthho sghinheskhgvrhhnvghlrdhorhhgnecuvehluhhsthgvrhfuihiivgepfe X-ME-Proxy: Received: from eros.localdomain (124-169-139-192.dyn.iinet.net.au [124.169.139.192]) by mail.messagingengine.com (Postfix) with ESMTPA id 82D07E40FF; Wed, 27 Mar 2019 01:18:40 -0400 (EDT) From: "Tobin C. Harding" To: Al Viro Cc: "Tobin C. Harding" , Jonathan Corbet , Mauro Carvalho Chehab , Neil Brown , Randy Dunlap , linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v3 05/24] fs: Guard unusual text with backticks Date: Wed, 27 Mar 2019 16:16:58 +1100 Message-Id: <20190327051717.23225-6-tobin@kernel.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190327051717.23225-1-tobin@kernel.org> References: <20190327051717.23225-1-tobin@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Currently we have unusual text which in context is clear @flags: O_... flags with which the new file will be opened Currently this docstring is _not_ included in any documentation file but if it is in future this will cause Sphinx to emit a warning (as discovered while documenting alloc_file_pseudo()). Let's fix it now to save our future selves the hassle. Guard unusual text with backticks. Signed-off-by: Tobin C. Harding --- fs/file_table.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fs/file_table.c b/fs/file_table.c index e3c6966c2d53..89875f1a1195 100644 --- a/fs/file_table.c +++ b/fs/file_table.c @@ -180,7 +180,7 @@ struct file *alloc_empty_file_noaccount(int flags, const struct cred *cred) /** * alloc_file() - Allocate and initialize a &struct file. * @path: the (dentry, vfsmount) pair for the new file - * @flags: O_... flags with which the new file will be opened + * @flags: ``O_...`` flags with which the new file will be opened * @fop: the 'struct file_operations' for the new file */ static struct file *alloc_file(const struct path *path, int flags, -- 2.21.0