2020-02-20 21:40:47

by Tycho Andersen

[permalink] [raw]
Subject: [PATCH] doc: fix filesystems/porting.rst whitespace

If we start with spaces instead of tabs, rst seems to get confused and
italicize some things (presumably because of the `*'s).

Instead, let's switch to using leading tabs as we do elsewhere in the file.

Signed-off-by: Tycho Andersen <[email protected]>
---
Documentation/filesystems/porting.rst | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/Documentation/filesystems/porting.rst b/Documentation/filesystems/porting.rst
index f18506083ced..898e1d0c6e98 100644
--- a/Documentation/filesystems/porting.rst
+++ b/Documentation/filesystems/porting.rst
@@ -57,12 +57,13 @@ Turn your foo_read_super() into a function that would return 0 in case of
success and negative number in case of error (-EINVAL unless you have more
informative error value to report). Call it foo_fill_super(). Now declare::

- int foo_get_sb(struct file_system_type *fs_type,
- int flags, const char *dev_name, void *data, struct vfsmount *mnt)
- {
- return get_sb_bdev(fs_type, flags, dev_name, data, foo_fill_super,
- mnt);
- }
+ int foo_get_sb(struct file_system_type *fs_type,
+ int flags, const char *dev_name, void *data,
+ struct vfsmount *mnt)
+ {
+ return get_sb_bdev(fs_type, flags, dev_name, data, foo_fill_super,
+ mnt);
+ }

(or similar with s/bdev/nodev/ or s/bdev/single/, depending on the kind of
filesystem).
@@ -181,10 +182,10 @@ can be used as examples of very different filesystems.
iget4() and the read_inode2 callback have been superseded by iget5_locked()
which has the following prototype::

- struct inode *iget5_locked(struct super_block *sb, unsigned long ino,
- int (*test)(struct inode *, void *),
- int (*set)(struct inode *, void *),
- void *data);
+ struct inode *iget5_locked(struct super_block *sb, unsigned long ino,
+ int (*test)(struct inode *, void *),
+ int (*set)(struct inode *, void *),
+ void *data);

'test' is an additional function that can be used when the inode
number is not sufficient to identify the actual file object. 'set'
--
2.20.1


2020-02-25 10:22:13

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] doc: fix filesystems/porting.rst whitespace

On Thu, 20 Feb 2020 14:40:09 -0700
Tycho Andersen <[email protected]> wrote:

> If we start with spaces instead of tabs, rst seems to get confused and
> italicize some things (presumably because of the `*'s).
>
> Instead, let's switch to using leading tabs as we do elsewhere in the file.
>
> Signed-off-by: Tycho Andersen <[email protected]>
> ---
> Documentation/filesystems/porting.rst | 21 +++++++++++----------
> 1 file changed, 11 insertions(+), 10 deletions(-)

So I don't see that problem in my builds, and it doesn't show in the
version on kernel.org either. What version of sphinx are you running?

Thanks,

jon

2020-02-25 17:20:32

by Tycho Andersen

[permalink] [raw]
Subject: Re: [PATCH] doc: fix filesystems/porting.rst whitespace

On Tue, Feb 25, 2020 at 03:20:28AM -0700, Jonathan Corbet wrote:
> On Thu, 20 Feb 2020 14:40:09 -0700
> Tycho Andersen <[email protected]> wrote:
>
> > If we start with spaces instead of tabs, rst seems to get confused and
> > italicize some things (presumably because of the `*'s).
> >
> > Instead, let's switch to using leading tabs as we do elsewhere in the file.
> >
> > Signed-off-by: Tycho Andersen <[email protected]>
> > ---
> > Documentation/filesystems/porting.rst | 21 +++++++++++----------
> > 1 file changed, 11 insertions(+), 10 deletions(-)
>
> So I don't see that problem in my builds, and it doesn't show in the
> version on kernel.org either. What version of sphinx are you running?

It's actually the default vim syntax highlighter that gets confused in
my case,

VIM - Vi IMproved 8.1 (2018 May 18, compiled Sep 05 2019 11:15:15)
Included patches: 1-875, 878, 884, 948, 1046, 1365-1368, 1382, 1401

Tycho

2020-02-26 11:22:14

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] doc: fix filesystems/porting.rst whitespace

On Tue, 25 Feb 2020 09:59:54 -0700
Tycho Andersen <[email protected]> wrote:

> > So I don't see that problem in my builds, and it doesn't show in the
> > version on kernel.org either. What version of sphinx are you running?
>
> It's actually the default vim syntax highlighter that gets confused in
> my case,

So this is actually a vim bug, then, right?

Thanks,

jon

2020-02-26 11:31:42

by David Laight

[permalink] [raw]
Subject: RE: [PATCH] doc: fix filesystems/porting.rst whitespace

> It's actually the default vim syntax highlighter that gets confused in
> my case,
>
> VIM - Vi IMproved 8.1 (2018 May 18, compiled Sep 05 2019 11:15:15)
> Included patches: 1-875, 878, 884, 948, 1046, 1365-1368, 1382, 1401

Yep, syntax highlighting doesn't stand a chance of getting it right.
Just makes it look as though someone has vomited on the screen.

Best to turn it off.

David

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK
Registration No: 1397386 (Wales)