linux-kernel - Re: [PATCH RESEND v2] Documentation: xfs: consolidate XFS docs into its own subdirectory

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20231129071750.GU36211@frogsfrogsfrogs>
Date:   Tue, 28 Nov 2023 23:17:50 -0800
From:   "Darrick J. Wong" <djwong@...nel.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>
Cc:     Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Documentation <linux-doc@...r.kernel.org>,
        Linux XFS <linux-xfs@...r.kernel.org>,
        Linux Kernel Workflows <workflows@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Chandan Babu R <chandan.babu@...cle.com>,
        Namjae Jeon <linkinjeon@...nel.org>,
        Dave Chinner <dchinner@...hat.com>,
        Steve French <stfrench@...rosoft.com>,
        "Matthew Wilcox (Oracle)" <willy@...radead.org>,
        Allison Henderson <allison.henderson@...cle.com>,
        Bjorn Helgaas <bhelgaas@...gle.com>,
        Charles Han <hanchunchao@...pur.com>,
        Vegard Nossum <vegard.nossum@...cle.com>
Subject: Re: [PATCH RESEND v2] Documentation: xfs: consolidate XFS docs into
 its own subdirectory

On Wed, Nov 29, 2023 at 02:12:45PM +0700, Bagas Sanjaya wrote:
> On Tue, Nov 28, 2023 at 09:24:00PM -0800, Darrick J. Wong wrote:
> > On Tue, Nov 28, 2023 at 08:32:55AM -0800, Darrick J. Wong wrote:
> > > On Tue, Nov 28, 2023 at 07:45:22PM +0700, Bagas Sanjaya wrote:
> > > > XFS docs are currently in upper-level Documentation/filesystems.
> > > > Although these are currently 4 docs, they are already outstanding as
> > > > a group and can be moved to its own subdirectory.
> > > > 
> > > > Consolidate them into Documentation/filesystems/xfs/.
> > > > 
> > > > Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> > > > ---
> > > > Changes since v1 [1]:
> > > > 
> > > >   * Also update references to old doc path to address kernel test robot
> > > >     warnings [2].
> > > > 
> > > > [1]: https://lore.kernel.org/linux-doc/20231121095658.28254-1-bagasdotme@gmail.com/
> > > > [2]: https://lore.kernel.org/linux-doc/a9abc5ec-f3cd-4a1a-81b9-a6900124d38b@gmail.com/
> > > > 
> > > >  Documentation/filesystems/index.rst                |  5 +----
> > > >  Documentation/filesystems/xfs/index.rst            | 14 ++++++++++++++
> > > >  .../{ => xfs}/xfs-delayed-logging-design.rst       |  0
> > > >  .../{ => xfs}/xfs-maintainer-entry-profile.rst     |  0
> > > >  .../{ => xfs}/xfs-online-fsck-design.rst           |  2 +-
> > > >  .../{ => xfs}/xfs-self-describing-metadata.rst     |  0
> > > >  .../maintainer/maintainer-entry-profile.rst        |  2 +-
> > > >  MAINTAINERS                                        |  4 ++--
> > > >  8 files changed, 19 insertions(+), 8 deletions(-)
> > > >  create mode 100644 Documentation/filesystems/xfs/index.rst
> > > >  rename Documentation/filesystems/{ => xfs}/xfs-delayed-logging-design.rst (100%)
> > > >  rename Documentation/filesystems/{ => xfs}/xfs-maintainer-entry-profile.rst (100%)
> > > >  rename Documentation/filesystems/{ => xfs}/xfs-online-fsck-design.rst (99%)
> > > >  rename Documentation/filesystems/{ => xfs}/xfs-self-describing-metadata.rst (100%)
> > > 
> > > I think the rst filename should drop the 'xfs-' prefix, e.g.
> > > 
> > > 	Documentation/filesystems/xfs/delayed-logging-design.rst
> > > 
> > > since that seems to be what most filesystems do:
> > 
> > Actually, ignore this suggestion.  I forgot that I have vim paths
> > trained on the Documentation/filesystems/ directory, which means I'll
> > lose the ability to
> > 
> > :f xfs-online-fsck-design.rst
> > 
> > and pop it open.  Not that I expect many more filesystems to grow online
> > fsck capabilities, but you get the point...
> 
> So is it OK to just move the the docs and keeping their basename intact (as I
> did here)?

Correct.

> > > > diff --git a/MAINTAINERS b/MAINTAINERS
> > > > index ea790149af7951..fd288ac57e19fb 100644
> > > > --- a/MAINTAINERS
> > > > +++ b/MAINTAINERS
> > > > @@ -23893,10 +23893,10 @@ S:	Supported
> > > >  W:	http://xfs.org/
> > > >  C:	irc://irc.oftc.net/xfs
> > > >  T:	git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
> > > > -P:	Documentation/filesystems/xfs-maintainer-entry-profile.rst
> > > > +P:	Documentation/filesystems/xfs/xfs-maintainer-entry-profile.rst
> > > >  F:	Documentation/ABI/testing/sysfs-fs-xfs
> > > >  F:	Documentation/admin-guide/xfs.rst
> > > > -F:	Documentation/filesystems/xfs-*
> > > > +F:	Documentation/filesystems/xfs/xfs-*
> > > 
> > > Shouldn't this be "Documentation/filesystems/xfs/*" ?
> > 
> > ...though this suggestion remains standing.
> 
> OK, will fix it up in v3.

Ok, thanks!

--D

> -- 
> An old man doll... just what I always wanted! - Clara