linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <tobin@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Tobin C. Harding" <tobin@kernel.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	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	[thread overview]
Message-ID: <20190318231437.1666-14-tobin@kernel.org> (raw)
In-Reply-To: <20190318231437.1666-1-tobin@kernel.org>

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 <rdunlap@infradead.org>
Signed-off-by: Tobin C. Harding <tobin@kernel.org>
---
 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).
-- 
2.21.0


      parent reply	other threads:[~2019-03-18 23:16 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-18 23:14 [PATCH v2 00/13] Convert vfs.txt to vfs.rst Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 01/13] docs: filesystems: vfs: Remove space before tab Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 02/13] docs: filesystems: vfs: Use uniform space after period Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 03/13] docs: filesystems: vfs: Use 72 character column width Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 04/13] docs: filesystems: vfs: Use uniform spacing around headings Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 05/13] docs: filesystems: vfs: Use correct initial heading Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 06/13] docs: filesystems: vfs: Use SPDX identifier Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 07/13] docs: filesystems: vfs: Fix pre-amble indentation Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 08/13] docs: filesystems: vfs: Use list character for lists Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 09/13] docs: filesystems: vfs: Add code-block and txt->RST Tobin C. Harding
2019-03-19  1:35   ` Tobin C. Harding
2019-03-19 23:42     ` Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 10/13] docs: filesystems: vfs: Use ticks for listed items Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 11/13] docs: filesystems: vfs: Clean up lists Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 12/13] docs: filesystems: vfs: Do minor grammar fixes Tobin C. Harding
2019-03-18 23:14 ` Tobin C. Harding [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190318231437.1666-14-tobin@kernel.org \
    --to=tobin@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).