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

docs: filesystems: convert ubifs.txt to ReST

- Add a SPDX header;
- Add a document title;
- Adjust section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

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

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
38e56b4e 688f118e

+19 -7
+1
Documentation/filesystems/index.rst
··· 90 90 sysfs 91 91 sysv-fs 92 92 tmpfs 93 + ubifs 93 94 ubifs-authentication.rst 94 95 virtiofs 95 96 vfat
+18 -7
Documentation/filesystems/ubifs.txt Documentation/filesystems/ubifs.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + =============== 4 + UBI File System 5 + =============== 6 + 1 7 Introduction 2 - ============= 8 + ============ 3 9 4 10 UBIFS file-system stands for UBI File System. UBI stands for "Unsorted 5 11 Block Images". UBIFS is a flash file system, which means it is designed ··· 85 79 86 80 (*) == default. 87 81 82 + ==================== ======================================================= 88 83 bulk_read read more in one go to take advantage of flash 89 84 media that read faster sequentially 90 85 no_bulk_read (*) do not bulk-read ··· 105 98 auth_hash_name= The hash algorithm used for authentication. Used for 106 99 both hashing and for creating HMACs. Typical values 107 100 include "sha256" or "sha512" 101 + ==================== ======================================================= 108 102 109 103 110 104 Quick usage instructions ··· 115 107 where "X" is UBI device number, "Y" is UBI volume number, and "NAME" is 116 108 UBI volume name. 117 109 118 - Mount volume 0 on UBI device 0 to /mnt/ubifs: 119 - $ mount -t ubifs ubi0_0 /mnt/ubifs 110 + Mount volume 0 on UBI device 0 to /mnt/ubifs:: 111 + 112 + $ mount -t ubifs ubi0_0 /mnt/ubifs 120 113 121 114 Mount "rootfs" volume of UBI device 0 to /mnt/ubifs ("rootfs" is volume 122 - name): 123 - $ mount -t ubifs ubi0:rootfs /mnt/ubifs 115 + name):: 116 + 117 + $ mount -t ubifs ubi0:rootfs /mnt/ubifs 124 118 125 119 The following is an example of the kernel boot arguments to attach mtd0 126 120 to UBI and mount volume "rootfs": ··· 132 122 ========== 133 123 134 124 UBIFS documentation and FAQ/HOWTO at the MTD web site: 135 - http://www.linux-mtd.infradead.org/doc/ubifs.html 136 - http://www.linux-mtd.infradead.org/faq/ubifs.html 125 + 126 + - http://www.linux-mtd.infradead.org/doc/ubifs.html 127 + - http://www.linux-mtd.infradead.org/faq/ubifs.html