Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36;
Date:   Mon, 30 Oct 2023 08:00:25 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Ariel Miculas <amiculas@cisco.com>, linux-doc@vger.kernel.org
Cc:     serge@hallyn.com, Phillip Lougher <phillip@squashfs.org.uk>,
        Jonathan Corbet <corbet@lwn.net>, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] docs: filesystems: document the squashfs specific
 mount options
Message-ID: <ZT8AKXruPLR0oUIM@debian.me>
References: <20231029161924.50648-1-amiculas@cisco.com>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="4FtQT5HRz676trB8"
Content-Disposition: inline
In-Reply-To: <20231029161924.50648-1-amiculas@cisco.com>
Precedence: bulk


--4FtQT5HRz676trB8
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Sun, Oct 29, 2023 at 06:19:24PM +0200, Ariel Miculas wrote:
> +2.1 Mount options
> +-----------------
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D    =3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D
> +errors=3D%s              Specify whether squashfs errors trigger a kerne=
l panic
> +                       or not
> +
> +		       =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D  =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +                         continue  errors don't trigger a panic (default)
> +                            panic  trigger a panic when errors are encou=
ntered,
> +                                   similar to several other filesystems =
(e.g.
> +                                   btrfs, ext4, f2fs, GFS2, jfs, ntfs, u=
bifs)
> +
> +                                   This allows a kernel dump to be saved,
> +                                   useful for analyzing and debugging the
> +                                   corruption.
> +                       =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D  =3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +threads=3D%s             Select the decompression mode or the number of =
threads
> +
> +                       If SQUASHFS_CHOICE_DECOMP_BY_MOUNT is set:
> +
> +		       =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D  =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +                           single  use single-threaded decompression (de=
fault)
> +
> +                                   Only one block (data or metadata) can=
 be
> +                                   decompressed at any one time. This li=
mits
> +                                   CPU and memory usage to a minimum, bu=
t it
> +                                   also gives poor performance on parall=
el I/O
> +                                   workloads when using multiple CPU mac=
hines
> +                                   due to waiting on decompressor availa=
bility.
> +                            multi  use up to two parallel decompressors =
per core
> +
> +                                   If you have a parallel I/O workload a=
nd your
> +                                   system has enough memory, using this =
option
> +                                   may improve overall I/O performance. =
It
> +                                   dynamically allocates decompressors o=
n a
> +                                   demand basis.
> +                           percpu  use a maximum of one decompressor per=
 core
> +
> +                                   It uses percpu variables to ensure
> +                                   decompression is load-balanced across=
 the
> +                                   cores.
> +                        1|2|3|...  configure the number of threads used =
for
> +                                   decompression
> +
> +                                   The upper limit is num_online_cpus() =
* 2.
> +                       =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D  =3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +
> +                       If SQUASHFS_CHOICE_DECOMP_BY_MOUNT is **not** set=
 and
> +                       SQUASHFS_DECOMP_MULTI is set:
> +
> +		       =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D  =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +                          2|3|...  configure the number of threads used =
for
> +                                   decompression
> +
> +                                   The upper limit is num_online_cpus() =
* 2.
> +                       =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D  =3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D    =3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D
> +
>=20

The doc LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

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

--4FtQT5HRz676trB8
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZT8AIwAKCRD2uYlJVVFO
o5wjAQCsgbmSs7ucDXi9WqJ5A/Tf7HwOfCe7yWvzuqjkUcqcuAEArnipjFsP96Ve
bTHe4jPw2SCfz9icTUtm4UsAhcm6BA8=
=8P7/
-----END PGP SIGNATURE-----

--4FtQT5HRz676trB8--