Re: [PATCH 2/2] docs: filesystems: vfs: actualize struct super_operations description

[Eric Biggers <ebiggers@kernel.org>]

On Tue, Jan 31, 2023 at 10:12:42PM +0100, Aleksandr Mikhalitsyn wrote:
> On Tue, Jan 31, 2023 at 8:56 PM Jonathan Corbet <corbet@lwn.net> wrote:
> >
> > Alexander Mikhalitsyn <aleksandr.mikhalitsyn@canonical.com> writes:
> >
> > > Cc: linux-fsdevel@vger.kernel.org
> > > Cc: linux-doc@vger.kernel.org
> > > Signed-off-by: Alexander Mikhalitsyn <aleksandr.mikhalitsyn@canonical.com>
> > > ---
> > >  Documentation/filesystems/vfs.rst | 74 ++++++++++++++++++++++++-------
> > >  1 file changed, 59 insertions(+), 15 deletions(-)
> >
> > Thanks for updating this document!  That said, could I ask you, please,
> > to resubmit these with a proper changelog?  I'd also suggest copying Al
> > Viro, who will surely have comments on the changes you have made.
> 
> Hi, Jonathan!
> 
> Sure. Have done and of course I've to add Al Viro to CC, but forgot to do that,
> cause scripts/get_maintainer.pl have didn't remind me (-:
> 
> >
> > > diff --git a/Documentation/filesystems/vfs.rst b/Documentation/filesystems/vfs.rst
> > > index fab3bd702250..8671eafa745a 100644
> > > --- a/Documentation/filesystems/vfs.rst
> > > +++ b/Documentation/filesystems/vfs.rst
> > > @@ -242,33 +242,42 @@ struct super_operations
> > >  -----------------------
> > >
> > >  This describes how the VFS can manipulate the superblock of your
> > > -filesystem.  As of kernel 2.6.22, the following members are defined:
> > > +filesystem.  As of kernel 6.1, the following members are defined:
> >
> > Why not 6.2 while you're at it?  We might as well be as current as we
> > can while we're updating things.
> 
> I'm on 6.2, but for some reason decided to put 6.1. Will fix it :)
> 

It would be better to just remove the version number.  Whenever documentation
says something like "as of vX.Y.Z", people usually forget to update the version
number when updating the documentation.  So then we end up in the situation
where the documentation actually describes the latest kernel version, but it
claims to be describing an extremely old kernel version.

- Eric