Messages in this thread Patch in this message | | | From | "Tobin C. Harding" <> | Subject | [PATCH v2 13/13] docs: filesystems: vfs: Use backticks to guard star | Date | Tue, 19 Mar 2019 10:14:37 +1100 |
| |
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
| |