Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: filesystems: convert squashfs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/cec30862c7ee7de7f9cd903e35e6c8bf74cc928a.1581955849.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
31771f45 6db0a480

+34 -27
+1
Documentation/filesystems/index.rst
··· 86 86 ramfs-rootfs-initramfs 87 87 relay 88 88 romfs 89 + squashfs 89 90 virtiofs 90 91 vfat
+33 -27
Documentation/filesystems/squashfs.txt Documentation/filesystems/squashfs.rst
··· 1 - SQUASHFS 4.0 FILESYSTEM 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ======================= 4 + Squashfs 4.0 Filesystem 2 5 ======================= 3 6 4 7 Squashfs is a compressed read-only filesystem for Linux. 8 + 5 9 It uses zlib, lz4, lzo, or xz compression to compress files, inodes and 6 10 directories. Inodes in the system are very small and all blocks are packed to 7 11 minimise data overhead. Block sizes greater than 4K are supported up to a ··· 19 15 Mailing list: squashfs-devel@lists.sourceforge.net 20 16 Web site: www.squashfs.org 21 17 22 - 1. FILESYSTEM FEATURES 18 + 1. Filesystem Features 23 19 ---------------------- 24 20 25 21 Squashfs filesystem features versus Cramfs: 26 22 23 + ============================== ========= ========== 27 24 Squashfs Cramfs 28 - 29 - Max filesystem size: 2^64 256 MiB 30 - Max file size: ~ 2 TiB 16 MiB 31 - Max files: unlimited unlimited 32 - Max directories: unlimited unlimited 33 - Max entries per directory: unlimited unlimited 34 - Max block size: 1 MiB 4 KiB 35 - Metadata compression: yes no 36 - Directory indexes: yes no 37 - Sparse file support: yes no 38 - Tail-end packing (fragments): yes no 39 - Exportable (NFS etc.): yes no 40 - Hard link support: yes no 41 - "." and ".." in readdir: yes no 42 - Real inode numbers: yes no 43 - 32-bit uids/gids: yes no 44 - File creation time: yes no 45 - Xattr support: yes no 46 - ACL support: no no 25 + ============================== ========= ========== 26 + Max filesystem size 2^64 256 MiB 27 + Max file size ~ 2 TiB 16 MiB 28 + Max files unlimited unlimited 29 + Max directories unlimited unlimited 30 + Max entries per directory unlimited unlimited 31 + Max block size 1 MiB 4 KiB 32 + Metadata compression yes no 33 + Directory indexes yes no 34 + Sparse file support yes no 35 + Tail-end packing (fragments) yes no 36 + Exportable (NFS etc.) yes no 37 + Hard link support yes no 38 + "." and ".." in readdir yes no 39 + Real inode numbers yes no 40 + 32-bit uids/gids yes no 41 + File creation time yes no 42 + Xattr support yes no 43 + ACL support no no 44 + ============================== ========= ========== 47 45 48 46 Squashfs compresses data, inodes and directories. In addition, inode and 49 47 directory data are highly compacted, and packed on byte boundaries. Each ··· 53 47 file type, i.e. regular file, directory, symbolic link, and block/char device 54 48 inodes have different sizes). 55 49 56 - 2. USING SQUASHFS 50 + 2. Using Squashfs 57 51 ----------------- 58 52 59 53 As squashfs is a read-only filesystem, the mksquashfs program must be used to ··· 64 58 The squashfs-tools development tree is now located on kernel.org 65 59 git://git.kernel.org/pub/scm/fs/squashfs/squashfs-tools.git 66 60 67 - 3. SQUASHFS FILESYSTEM DESIGN 61 + 3. Squashfs Filesystem Design 68 62 ----------------------------- 69 63 70 64 A squashfs filesystem consists of a maximum of nine parts, packed together on a 71 - byte alignment: 65 + byte alignment:: 72 66 73 67 --------------- 74 68 | superblock | ··· 235 229 is stored. This xattr id is mapped into the location of the xattr 236 230 list using a second xattr id lookup table. 237 231 238 - 4. TODOS AND OUTSTANDING ISSUES 232 + 4. TODOs and Outstanding Issues 239 233 ------------------------------- 240 234 241 - 4.1 Todo list 235 + 4.1 TODO list 242 236 ------------- 243 237 244 238 Implement ACL support. 245 239 246 - 4.2 Squashfs internal cache 240 + 4.2 Squashfs Internal Cache 247 241 --------------------------- 248 242 249 243 Blocks in Squashfs are compressed. To avoid repeatedly decompressing