[Linux-kernel-mentees] Doc : fs : move xfs.txt to admin-guide
diff mbox series

Message ID 20190705131446.GA10045@localhost
State New
Headers show
Series
  • [Linux-kernel-mentees] Doc : fs : move xfs.txt to admin-guide
Related show

Commit Message

Sheriff Esseson July 5, 2019, 1:14 p.m. UTC
As suggested by Matthew Wilcox, xfs.txt is primarily a guide on available
options when setting up an XFS. This makes it appropriate to be placed under
the admin-guide tree.

Thus, move xfs.txt to admin-guide and fix broken references.

Signed-off-by: Sheriff Esseson <sheriffesseson@gmail.com>
---

The reference to xfs.txt from dax.txt in itself is not looking good. Maybe, we
need something more inspirational.

 Documentation/{filesystems => admin-guide}/xfs.txt | 0
 Documentation/filesystems/dax.txt                  | 2 +-
 MAINTAINERS                                        | 2 +-
 3 files changed, 2 insertions(+), 2 deletions(-)
 rename Documentation/{filesystems => admin-guide}/xfs.txt (100%)

--

Comments

Matthew Wilcox July 5, 2019, 7:04 p.m. UTC | #1
On Fri, Jul 05, 2019 at 02:14:46PM +0100, Sheriff Esseson wrote:
> As suggested by Matthew Wilcox, xfs.txt is primarily a guide on available
> options when setting up an XFS. This makes it appropriate to be placed under
> the admin-guide tree.
> 
> Thus, move xfs.txt to admin-guide and fix broken references.

What happened to the conversion to xfs.rst?
Sheriff Esseson July 5, 2019, 7:41 p.m. UTC | #2
On Fri, Jul 05, 2019 at 12:04:12PM -0700, Matthew Wilcox wrote:
> On Fri, Jul 05, 2019 at 02:14:46PM +0100, Sheriff Esseson wrote:
> > As suggested by Matthew Wilcox, xfs.txt is primarily a guide on available
> > options when setting up an XFS. This makes it appropriate to be placed under
> > the admin-guide tree.
> > 
> > Thus, move xfs.txt to admin-guide and fix broken references.
> 
> What happened to the conversion to xfs.rst?

Okay, I was thinking placing the file properly should come first before the
conversion.

I'll continue work on the conversion right away. I'll send it on Monday, letting
the dust settle on this one.
 
> 
> _______________________________________________
> Linux-kernel-mentees mailing list
> Linux-kernel-mentees@lists.linuxfoundation.org
> https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees


 thanks.
Matthew Wilcox July 8, 2019, 7:59 p.m. UTC | #3
On Fri, Jul 05, 2019 at 08:41:48PM +0100, Sheriff Esseson wrote:
> On Fri, Jul 05, 2019 at 12:04:12PM -0700, Matthew Wilcox wrote:
> > On Fri, Jul 05, 2019 at 02:14:46PM +0100, Sheriff Esseson wrote:
> > > As suggested by Matthew Wilcox, xfs.txt is primarily a guide on available
> > > options when setting up an XFS. This makes it appropriate to be placed under
> > > the admin-guide tree.
> > > 
> > > Thus, move xfs.txt to admin-guide and fix broken references.
> > 
> > What happened to the conversion to xfs.rst?
> 
> Okay, I was thinking placing the file properly should come first before the
> conversion.

But if you move it, then rename it, you have to change all these places
again.  The minimal conversion you did the first time was quite a nice diff
to read.
Christoph Hellwig July 8, 2019, 8 p.m. UTC | #4
The subjet line seems to be a bit messed up.

Patch
diff mbox series

diff --git a/Documentation/filesystems/xfs.txt b/Documentation/admin-guide/xfs.txt
similarity index 100%
rename from Documentation/filesystems/xfs.txt
rename to Documentation/admin-guide/xfs.txt
diff --git a/Documentation/filesystems/dax.txt b/Documentation/filesystems/dax.txt
index 6d2c0d340..b2b19738b 100644
--- a/Documentation/filesystems/dax.txt
+++ b/Documentation/filesystems/dax.txt
@@ -76,7 +76,7 @@  exposure of uninitialized data through mmap.
 These filesystems may be used for inspiration:
 - ext2: see Documentation/filesystems/ext2.txt
 - ext4: see Documentation/filesystems/ext4/
-- xfs:  see Documentation/filesystems/xfs.txt
+- xfs:  see Documentation/admin-guide/xfs.txt


 Handling Media Errors
diff --git a/MAINTAINERS b/MAINTAINERS
index 01a52fc96..fc309b0a1 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -17374,7 +17374,7 @@  L:	linux-xfs@vger.kernel.org
 W:	http://xfs.org/
 T:	git git://git.kernel.org/pub/scm/fs/xfs/xfs-linux.git
 S:	Supported
-F:	Documentation/filesystems/xfs.txt
+F:	Documentation/admin-guide/xfs.txt
 F:	fs/xfs/

 XILINX AXI ETHERNET DRIVER