Documentation: filesystems: update filename extensions

Commit Message

Randy Dunlap Nov. 20, 2024, 5:52 a.m. UTC

Update references to most txt files to rst files.
Update one reference to an md file to a rst file.
Update one file path to its current location.

Signed-off-by: Randy Dunlap <[e-mail]>
Cc: Jonathan Corbet <[e-mail]>
Cc: [e-mail]
Cc: Alexander Viro <[e-mail]>
Cc: Christian Brauner <[e-mail]>
Cc: Jan Kara <[e-mail]>
Cc: [e-mail]
Cc: Ian Kent <[e-mail]>
Cc: [e-mail]
Cc: Alexander Aring <[e-mail]>
Cc: David Teigland <[e-mail]>
Cc: [e-mail]
Cc: Eric Biggers <[e-mail]>
Cc: Theodore Y. Ts'o <[e-mail]>
Cc: [e-mail]
Cc: Mark Fasheh <[e-mail]>
Cc: Joel Becker <[e-mail]>
Cc: Joseph Qi <[e-mail]>
Cc: [e-mail]
---
 Documentation/filesystems/autofs.rst                 |    2 +-
 Documentation/filesystems/dlmfs.rst                  |    2 +-
 Documentation/filesystems/fsverity.rst               |    2 +-
 Documentation/filesystems/path-lookup.rst            |    2 +-
 Documentation/filesystems/path-lookup.txt            |    2 +-
 Documentation/filesystems/ramfs-rootfs-initramfs.rst |    2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

Comments

Christian Brauner Nov. 20, 2024, 10:23 a.m. UTC | #1

On Tue, Nov 19, 2024 at 09:52:46PM -0800, Randy Dunlap wrote:
> Update references to most txt files to rst files.
> Update one reference to an md file to a rst file.
> Update one file path to its current location.
> 
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Jonathan Corbet <[e-mail]>
> Cc: [e-mail]
> Cc: Alexander Viro <[e-mail]>
> Cc: Christian Brauner <[e-mail]>
> Cc: Jan Kara <[e-mail]>
> Cc: [e-mail]
> Cc: Ian Kent <[e-mail]>
> Cc: [e-mail]
> Cc: Alexander Aring <[e-mail]>
> Cc: David Teigland <[e-mail]>
> Cc: [e-mail]
> Cc: Eric Biggers <[e-mail]>
> Cc: Theodore Y. Ts'o <[e-mail]>
> Cc: [e-mail]
> Cc: Mark Fasheh <[e-mail]>
> Cc: Joel Becker <[e-mail]>
> Cc: Joseph Qi <[e-mail]>
> Cc: [e-mail]
> ---

Reviewed-by: Christian Brauner (Microsoft) <[e-mail]>

@Jon, should I take this through the vfs tree?

Jonathan Corbet Nov. 20, 2024, 3:22 p.m. UTC | #2

Christian Brauner <[e-mail]> writes:

>
> Reviewed-by: Christian Brauner (Microsoft) <[e-mail]>
>
> @Jon, should I take this through the vfs tree?

Up to you.  It looks like I'll definitely have another pull request
during this merge window, so I can get it Linusward too.  Just lemme
know what your preference is.

jon

Jonathan Corbet Nov. 22, 2024, 5:34 p.m. UTC | #3

Randy Dunlap <[e-mail]> writes:

> Update references to most txt files to rst files.
> Update one reference to an md file to a rst file.
> Update one file path to its current location.
>
> Signed-off-by: Randy Dunlap <[e-mail]>
> Cc: Jonathan Corbet <[e-mail]>
> Cc: [e-mail]
> Cc: Alexander Viro <[e-mail]>
> Cc: Christian Brauner <[e-mail]>
> Cc: Jan Kara <[e-mail]>
> Cc: [e-mail]
> Cc: Ian Kent <[e-mail]>
> Cc: [e-mail]
> Cc: Alexander Aring <[e-mail]>
> Cc: David Teigland <[e-mail]>
> Cc: [e-mail]
> Cc: Eric Biggers <[e-mail]>
> Cc: Theodore Y. Ts'o <[e-mail]>
> Cc: [e-mail]
> Cc: Mark Fasheh <[e-mail]>
> Cc: Joel Becker <[e-mail]>
> Cc: Joseph Qi <[e-mail]>
> Cc: [e-mail]
> ---
>  Documentation/filesystems/autofs.rst                 |    2 +-
>  Documentation/filesystems/dlmfs.rst                  |    2 +-
>  Documentation/filesystems/fsverity.rst               |    2 +-
>  Documentation/filesystems/path-lookup.rst            |    2 +-
>  Documentation/filesystems/path-lookup.txt            |    2 +-
>  Documentation/filesystems/ramfs-rootfs-initramfs.rst |    2 +-
>  6 files changed, 6 insertions(+), 6 deletions(-)

Applied, thanks.

jon

Patch

--- linux-next-20241119.orig/Documentation/filesystems/autofs.rst
+++ linux-next-20241119/Documentation/filesystems/autofs.rst
@@ -442,7 +442,7 @@  which can be used to communicate directl
 It requires CAP_SYS_ADMIN for access.
 
 The 'ioctl's that can be used on this device are described in a separate
-document `autofs-mount-control.txt`, and are summarised briefly here.
+document `autofs-mount-control.rst`, and are summarised briefly here.
 Each ioctl is passed a pointer to an `autofs_dev_ioctl` structure::
 
         struct autofs_dev_ioctl {
--- linux-next-20241119.orig/Documentation/filesystems/dlmfs.rst
+++ linux-next-20241119/Documentation/filesystems/dlmfs.rst
@@ -36,7 +36,7 @@  None
 Usage
 =====
 
-If you're just interested in OCFS2, then please see ocfs2.txt. The
+If you're just interested in OCFS2, then please see ocfs2.rst. The
 rest of this document will be geared towards those who want to use
 dlmfs for easy to setup and easy to use clustered locking in
 userspace.
--- linux-next-20241119.orig/Documentation/filesystems/fsverity.rst
+++ linux-next-20241119/Documentation/filesystems/fsverity.rst
@@ -16,7 +16,7 @@  btrfs filesystems.  Like fscrypt, not to
 code is needed to support fs-verity.
 
 fs-verity is similar to `dm-verity
-<https://www.kernel.org/doc/Documentation/device-mapper/verity.txt>`_
+<https://www.kernel.org/doc/Documentation/admin-guide/device-mapper/verity.rst>`_
 but works on files rather than block devices.  On regular files on
 filesystems supporting fs-verity, userspace can execute an ioctl that
 causes the filesystem to build a Merkle tree for the file and persist
--- linux-next-20241119.orig/Documentation/filesystems/path-lookup.rst
+++ linux-next-20241119/Documentation/filesystems/path-lookup.rst
@@ -531,7 +531,7 @@  this retry process in the next article.
 Automount points are locations in the filesystem where an attempt to
 lookup a name can trigger changes to how that lookup should be
 handled, in particular by mounting a filesystem there.  These are
-covered in greater detail in autofs.txt in the Linux documentation
+covered in greater detail in autofs.rst in the Linux documentation
 tree, but a few notes specifically related to path lookup are in order
 here.
 
--- linux-next-20241119.orig/Documentation/filesystems/ramfs-rootfs-initramfs.rst
+++ linux-next-20241119/Documentation/filesystems/ramfs-rootfs-initramfs.rst
@@ -315,7 +315,7 @@  the above threads) is:
 2) The cpio archive format chosen by the kernel is simpler and cleaner (and
    thus easier to create and parse) than any of the (literally dozens of)
    various tar archive formats.  The complete initramfs archive format is
-   explained in buffer-format.txt, created in usr/gen_init_cpio.c, and
+   explained in buffer-format.rst, created in usr/gen_init_cpio.c, and
    extracted in init/initramfs.c.  All three together come to less than 26k
    total of human-readable text.
 
--- linux-next-20241119.orig/Documentation/filesystems/path-lookup.txt
+++ linux-next-20241119/Documentation/filesystems/path-lookup.txt
@@ -379,4 +379,4 @@  Papers and other documentation on dcache
 
 2. http://lse.sourceforge.net/locking/dcache/dcache.html
 
-3. path-lookup.md in this directory.
+3. path-lookup.rst in this directory.