From patchwork Mon Mar 18 23:14:37 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Tobin C. Harding" X-Patchwork-Id: 10858611 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 1C06B13B5 for ; Mon, 18 Mar 2019 23:16:11 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F39C529530 for ; Mon, 18 Mar 2019 23:16:10 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E311529533; Mon, 18 Mar 2019 23:16:10 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 8A3BB29530 for ; Mon, 18 Mar 2019 23:16:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727953AbfCRXQI (ORCPT ); Mon, 18 Mar 2019 19:16:08 -0400 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:56153 "EHLO out2-smtp.messagingengine.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727929AbfCRXQC (ORCPT ); Mon, 18 Mar 2019 19:16:02 -0400 Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailout.nyi.internal (Postfix) with ESMTP id B25462225D; Mon, 18 Mar 2019 19:16:00 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute3.internal (MEProxy); Mon, 18 Mar 2019 19:16:00 -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=wO87VhxlCRKJ6UZlTZ7CZPC3aFH+ZWg+1lDNDo6jzTY=; b=rj5LEI8w 3oY1HSnHFAAy1aECihxdSO4BhYbR3a7m4h8aZVZyiSnRrHpvDwL7jULer2aIOK1Z usqY5sOx72yCP903jHAVEVB/Avnibesl+2dUC1hYkvuDcH4cQcohrUqz+I3oZOQm UrP5otMzKLvl/10Ke7IXlQoKxzriKFC/WUjDUzVcPXkpmMxr9il3SblpYS4LcHCN c64nfdrh7ezm437Rzu181/gY3iih9gOQz/bp0N3E3D0jbvqlPutPTUT7M0cbd2O4 pJeOFPl70EIQmgM2TU/jJk3WaU1b/oFiiyPXNBnTcHXsIKdoANBUjuhwC4BbdH09 xok9eiwaQWlFIg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedutddriedvgddtfecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepfdfvohgsihhn ucevrdcujfgrrhguihhnghdfuceothhosghinheskhgvrhhnvghlrdhorhhgqeenucfkph epuddvgedrudeiledrudegledrgedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehtohgs ihhnsehkvghrnhgvlhdrohhrghenucevlhhushhtvghrufhiiigvpeduud X-ME-Proxy: Received: from eros.localdomain (124-169-149-40.dyn.iinet.net.au [124.169.149.40]) by mail.messagingengine.com (Postfix) with ESMTPA id 1C70910311; Mon, 18 Mar 2019 19:15:57 -0400 (EDT) From: "Tobin C. Harding" To: Jonathan Corbet Cc: "Tobin C. Harding" , Randy Dunlap , linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH v2 13/13] docs: filesystems: vfs: Use backticks to guard star Date: Tue, 19 Mar 2019 10:14:37 +1100 Message-Id: <20190318231437.1666-14-tobin@kernel.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190318231437.1666-1-tobin@kernel.org> References: <20190318231437.1666-1-tobin@kernel.org> MIME-Version: 1.0 Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Sphinx emits a warning because of the use of a * (C pointer construct) within the document. We can prevent this by guarding the C source code with back ticks. Use backticks to guard star (C pointer). Tested-by: Randy Dunlap Signed-off-by: Tobin C. Harding --- Documentation/filesystems/vfs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/filesystems/vfs.rst b/Documentation/filesystems/vfs.rst index 12b8e90403eb..8ad2507b3df6 100644 --- a/Documentation/filesystems/vfs.rst +++ b/Documentation/filesystems/vfs.rst @@ -355,7 +355,7 @@ Extended attributes are name:value pairs. When none of the xattr handlers of a filesystem match the specified attribute name or when a filesystem doesn't support extended attributes, -the various *xattr(2) system calls return -EOPNOTSUPP. +the various ``*xattr(2)`` system calls return -EOPNOTSUPP. The Inode Object @@ -722,7 +722,7 @@ cache in your filesystem. The following members are defined: out properly. The filesystem must return the locked pagecache page for the specified - offset, in *pagep, for the caller to write into. + offset, in ``*pagep``, for the caller to write into. It must be able to cope with short writes (where the length passed to write_begin is greater than the number of bytes copied into the page).