Commit 38e56b4e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/9043dc2965cafc64e6a521e2317c00ecc8303bf6.1581955849.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 688f118e

Documentation/filesystems/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -90,6 +90,7 @@ Documentation for filesystem implementations. 
   sysfs

   sysv-fs

   tmpfs

   ubifs

   ubifs-authentication.rst

   virtiofs

   vfat

Documentation/filesystems/ubifs.txt→Documentation/filesystems/ubifs.rst

+18 −7
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



===============

UBI File System

===============



Introduction

=============

============



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
@@ -79,6 +85,7 @@ Mount options 


(*) == default.



====================	=======================================================

bulk_read		read more in one go to take advantage of flash

			media that read faster sequentially

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

			both hashing and for creating HMACs. Typical values

			include "sha256" or "sha512"

====================	=======================================================





Quick usage instructions
@@ -107,11 +115,13 @@ 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

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 "rootfs" volume of UBI device 0 to /mnt/ubifs ("rootfs" is volume

name):

name)::



    $ mount -t ubifs ubi0:rootfs /mnt/ubifs



The following is an example of the kernel boot arguments to attach mtd0
@@ -122,5 +132,6 @@ References 
==========



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

CRA Git | Maintained and supported by SUSTech CRA and CCSE