docs: filesystems: document the squashfs specific mount options
authorAriel Miculas <amiculas@cisco.com>
Fri, 17 Nov 2023 16:12:14 +0000 (18:12 +0200)
committerAndrew Morton <akpm@linux-foundation.org>
Mon, 11 Dec 2023 01:21:31 +0000 (17:21 -0800)
commit48aa137e5a9491b491ae2bea0e0a603b330e708f
treecf076c04d4dd3a4c5de9b6d836e6481da8ed638f
parent71aa3419e98f6e23bddc3aca9ec4ac368836a109
docs: filesystems: document the squashfs specific mount options

When SQUASHFS_CHOICE_DECOMP_BY_MOUNT is set, the "threads" mount option
can be used to specify the decompression mode: single-threaded,
multi-threaded, percpu or the number of threads used for decompression.
When SQUASHFS_CHOICE_DECOMP_BY_MOUNT is not set, SQUASHFS_DECOMP_MULTI and
SQUASHFS_MOUNT_DECOMP_THREADS are both set, the "threads" option can also
be used to specify the number of threads used for decompression.  This
mount option is only mentioned in fs/squashfs/Kconfig, which makes it
difficult to find.

Another mount option available is "errors", which can be configured to
panic the kernel when squashfs errors are encountered.

Add both these options to the squashfs documentation, making them more
noticeable.

Link: https://lkml.kernel.org/r/20231117161215.140282-1-amiculas@cisco.com
Signed-off-by: Ariel Miculas <amiculas@cisco.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Phillip Lougher <phillip@squashfs.org.uk>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Serge Hallyn <serge@hallyn.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Documentation/filesystems/squashfs.rst