diff mbox series

[v3,05/24] fs: Guard unusual text with backticks

Message ID 20190327051717.23225-6-tobin@kernel.org (mailing list archive)
State New, archived
Headers show
Series Convert vfs.txt to vfs.rst | expand

Commit Message

Tobin C. Harding March 27, 2019, 5:16 a.m. UTC 
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 <tobin@kernel.org>
---
 fs/file_table.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

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,