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>
This commit is contained in:
Mauro Carvalho Chehab 2020-02-17 17:12:28 +01:00 committed by Jonathan Corbet
parent 688f118e31
commit 38e56b4ec4
2 changed files with 19 additions and 7 deletions

View File

@ -90,6 +90,7 @@ Documentation for filesystem implementations.
sysfs sysfs
sysv-fs sysv-fs
tmpfs tmpfs
ubifs
ubifs-authentication.rst ubifs-authentication.rst
virtiofs virtiofs
vfat vfat

View File

@ -1,5 +1,11 @@
.. SPDX-License-Identifier: GPL-2.0
===============
UBI File System
===============
Introduction Introduction
============= ============
UBIFS file-system stands for UBI File System. UBI stands for "Unsorted UBIFS file-system stands for UBI File System. UBI stands for "Unsorted
Block Images". UBIFS is a flash file system, which means it is designed Block Images". UBIFS is a flash file system, which means it is designed
@ -79,6 +85,7 @@ Mount options
(*) == default. (*) == default.
==================== =======================================================
bulk_read read more in one go to take advantage of flash bulk_read read more in one go to take advantage of flash
media that read faster sequentially media that read faster sequentially
no_bulk_read (*) do not bulk-read no_bulk_read (*) do not bulk-read
@ -98,6 +105,7 @@ auth_key= specify the key used for authenticating the filesystem.
auth_hash_name= The hash algorithm used for authentication. Used for auth_hash_name= The hash algorithm used for authentication. Used for
both hashing and for creating HMACs. Typical values both hashing and for creating HMACs. Typical values
include "sha256" or "sha512" include "sha256" or "sha512"
==================== =======================================================
Quick usage instructions Quick usage instructions
@ -107,12 +115,14 @@ The UBI volume to mount is specified using "ubiX_Y" or "ubiX:NAME" syntax,
where "X" is UBI device number, "Y" is UBI volume number, and "NAME" is where "X" is UBI device number, "Y" is UBI volume number, and "NAME" is
UBI volume name. UBI volume name.
Mount volume 0 on UBI device 0 to /mnt/ubifs: Mount volume 0 on UBI device 0 to /mnt/ubifs::
$ mount -t ubifs ubi0_0 /mnt/ubifs
$ mount -t ubifs ubi0_0 /mnt/ubifs
Mount "rootfs" volume of UBI device 0 to /mnt/ubifs ("rootfs" is volume Mount "rootfs" volume of UBI device 0 to /mnt/ubifs ("rootfs" is volume
name): name)::
$ mount -t ubifs ubi0:rootfs /mnt/ubifs
$ mount -t ubifs ubi0:rootfs /mnt/ubifs
The following is an example of the kernel boot arguments to attach mtd0 The following is an example of the kernel boot arguments to attach mtd0
to UBI and mount volume "rootfs": to UBI and mount volume "rootfs":
@ -122,5 +132,6 @@ References
========== ==========
UBIFS documentation and FAQ/HOWTO at the MTD web site: UBIFS documentation and FAQ/HOWTO at the MTD web site:
http://www.linux-mtd.infradead.org/doc/ubifs.html
http://www.linux-mtd.infradead.org/faq/ubifs.html - http://www.linux-mtd.infradead.org/doc/ubifs.html
- http://www.linux-mtd.infradead.org/faq/ubifs.html