From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, Jonathan Corbet <corbet@lwn.net>, linux-fsdevel@vger.kernel.org, Richard Weinberger <richard@nod.at>, linux-mtd@lists.infradead.org Subject: [PATCH 42/44] docs: filesystems: convert ubifs.txt to ReST Date: Mon, 17 Feb 2020 17:12:28 +0100 [thread overview] Message-ID: <9043dc2965cafc64e6a521e2317c00ecc8303bf6.1581955849.git.mchehab+huawei@kernel.org> (raw) In-Reply-To: <cover.1581955849.git.mchehab+huawei@kernel.org> - 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> --- Documentation/filesystems/index.rst | 1 + .../filesystems/{ubifs.txt => ubifs.rst} | 25 +++++++++++++------ 2 files changed, 19 insertions(+), 7 deletions(-) rename Documentation/filesystems/{ubifs.txt => ubifs.rst} (91%) diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index bb14738df358..58d57c9bf922 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -90,6 +90,7 @@ Documentation for filesystem implementations. sysfs sysv-fs tmpfs + ubifs ubifs-authentication.rst virtiofs vfat diff --git a/Documentation/filesystems/ubifs.txt b/Documentation/filesystems/ubifs.rst similarity index 91% rename from Documentation/filesystems/ubifs.txt rename to Documentation/filesystems/ubifs.rst index acc80442a3bb..e6ee99762534 100644 --- a/Documentation/filesystems/ubifs.txt +++ b/Documentation/filesystems/ubifs.rst @@ -1,5 +1,11 @@ +.. 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,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 UBI volume name. -Mount volume 0 on UBI device 0 to /mnt/ubifs: -$ mount -t ubifs ubi0_0 /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): -$ mount -t ubifs ubi0:rootfs /mnt/ubifs +name):: + + $ mount -t ubifs ubi0:rootfs /mnt/ubifs The following is an example of the kernel boot arguments to attach mtd0 to UBI and mount volume "rootfs": @@ -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 -- 2.24.1
WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> To: Linux Doc Mailing List <linux-doc@vger.kernel.org> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, linux-fsdevel@vger.kernel.org, linux-mtd@lists.infradead.org, Richard Weinberger <richard@nod.at>, Jonathan Corbet <corbet@lwn.net> Subject: [PATCH 42/44] docs: filesystems: convert ubifs.txt to ReST Date: Mon, 17 Feb 2020 17:12:28 +0100 [thread overview] Message-ID: <9043dc2965cafc64e6a521e2317c00ecc8303bf6.1581955849.git.mchehab+huawei@kernel.org> (raw) In-Reply-To: <cover.1581955849.git.mchehab+huawei@kernel.org> - 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> --- Documentation/filesystems/index.rst | 1 + .../filesystems/{ubifs.txt => ubifs.rst} | 25 +++++++++++++------ 2 files changed, 19 insertions(+), 7 deletions(-) rename Documentation/filesystems/{ubifs.txt => ubifs.rst} (91%) diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index bb14738df358..58d57c9bf922 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -90,6 +90,7 @@ Documentation for filesystem implementations. sysfs sysv-fs tmpfs + ubifs ubifs-authentication.rst virtiofs vfat diff --git a/Documentation/filesystems/ubifs.txt b/Documentation/filesystems/ubifs.rst similarity index 91% rename from Documentation/filesystems/ubifs.txt rename to Documentation/filesystems/ubifs.rst index acc80442a3bb..e6ee99762534 100644 --- a/Documentation/filesystems/ubifs.txt +++ b/Documentation/filesystems/ubifs.rst @@ -1,5 +1,11 @@ +.. 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,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 UBI volume name. -Mount volume 0 on UBI device 0 to /mnt/ubifs: -$ mount -t ubifs ubi0_0 /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): -$ mount -t ubifs ubi0:rootfs /mnt/ubifs +name):: + + $ mount -t ubifs ubi0:rootfs /mnt/ubifs The following is an example of the kernel boot arguments to attach mtd0 to UBI and mount volume "rootfs": @@ -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 -- 2.24.1 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
next prev parent reply other threads:[~2020-02-17 16:12 UTC|newest] Thread overview: 112+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-02-17 16:11 [PATCH 00/44] Manually convert filesystem FS documents to ReST Mauro Carvalho Chehab 2020-02-17 16:11 ` [Cluster-devel] " Mauro Carvalho Chehab 2020-02-17 16:11 ` Mauro Carvalho Chehab 2020-02-17 16:11 ` Mauro Carvalho Chehab 2020-02-17 16:11 ` [f2fs-dev] " Mauro Carvalho Chehab 2020-02-17 16:11 ` [Ocfs2-devel] " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 01/44] docs: filesystems: convert 9p.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 02/44] docs: filesystems: convert adfs.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 03/44] docs: filesystems: convert affs.txt " Mauro Carvalho Chehab 2020-02-18 13:04 ` David Sterba 2020-02-17 16:11 ` [PATCH 04/44] docs: filesystems: convert afs.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 05/44] docs: filesystems: convert autofs-mount-control.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 06/44] docs: filesystems: convert befs.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 07/44] docs: filesystems: convert bfs.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 08/44] docs: filesystems: convert btrfs.txt " Mauro Carvalho Chehab 2020-02-17 18:50 ` David Sterba 2020-02-17 19:34 ` Jonathan Corbet 2020-02-18 11:44 ` David Sterba 2020-02-17 16:11 ` [PATCH 09/44] docs: filesystems: convert ceph.txt " Mauro Carvalho Chehab 2020-02-18 11:57 ` Jeff Layton 2020-02-17 16:11 ` [PATCH 10/44] docs: filesystems: convert cramfs.txt " Mauro Carvalho Chehab 2020-02-17 18:11 ` Nicolas Pitre 2020-02-17 16:11 ` [PATCH 11/44] docs: filesystems: convert debugfs.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [PATCH 12/44] docs: filesystems: convert dlmfs.txt " Mauro Carvalho Chehab 2020-02-17 16:11 ` [Ocfs2-devel] " Mauro Carvalho Chehab 2020-02-18 1:21 ` Joseph Qi 2020-02-18 1:21 ` [Ocfs2-devel] " Joseph Qi 2020-02-18 10:07 ` Mauro Carvalho Chehab 2020-02-18 10:07 ` [Ocfs2-devel] " Mauro Carvalho Chehab 2020-02-18 10:55 ` Joseph Qi 2020-02-18 10:55 ` [Ocfs2-devel] " Joseph Qi 2020-02-17 16:11 ` [PATCH 13/44] docs: filesystems: convert ecryptfs.txt " Mauro Carvalho Chehab 2020-02-17 20:07 ` Tyler Hicks 2020-02-17 16:12 ` [PATCH 14/44] docs: filesystems: convert efivarfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 15/44] docs: filesystems: convert erofs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 16/44] docs: filesystems: convert ext2.txt " Mauro Carvalho Chehab 2020-02-18 7:11 ` Jan Kara 2020-02-17 16:12 ` [PATCH 17/44] docs: filesystems: convert ext3.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 18/44] docs: filesystems: convert f2fs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [f2fs-dev] " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 19/44] docs: filesystems: convert gfs2.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [Cluster-devel] " Mauro Carvalho Chehab 2020-02-18 13:13 ` Bob Peterson 2020-02-18 13:13 ` [Cluster-devel] " Bob Peterson 2020-02-17 16:12 ` [PATCH 20/44] docs: filesystems: convert gfs2-uevents.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [Cluster-devel] " Mauro Carvalho Chehab 2020-02-18 13:13 ` Bob Peterson 2020-02-18 13:13 ` [Cluster-devel] " Bob Peterson 2020-02-17 16:12 ` [PATCH 21/44] docs: filesystems: convert hfsplus.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 22/44] docs: filesystems: convert hfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 23/44] docs: filesystems: convert hpfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 24/44] docs: filesystems: convert inotify.txt " Mauro Carvalho Chehab 2020-02-18 7:10 ` Jan Kara 2020-02-17 16:12 ` [PATCH 25/44] docs: filesystems: convert isofs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 26/44] docs: filesystems: convert nilfs2.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 27/44] docs: filesystems: convert ntfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 28/44] docs: filesystems: convert ocfs2-online-filecheck.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 29/44] docs: filesystems: convert ocfs2.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [Ocfs2-devel] " Mauro Carvalho Chehab 2020-02-18 1:23 ` Joseph Qi 2020-02-18 1:23 ` [Ocfs2-devel] " Joseph Qi 2020-02-17 16:12 ` [PATCH 30/44] docs: filesystems: convert omfs.txt " Mauro Carvalho Chehab 2020-02-18 0:57 ` Bob Copeland 2020-02-17 16:12 ` [PATCH 31/44] docs: filesystems: convert orangefs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 33/44] docs: filesystems: convert qnx6.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 34/44] docs: filesystems: convert ramfs-rootfs-initramfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 35/44] docs: filesystems: convert relay.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 36/44] docs: filesystems: convert romfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 37/44] docs: filesystems: convert squashfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 38/44] docs: filesystems: convert sysfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 39/44] docs: filesystems: convert sysv-fs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 40/44] docs: filesystems: convert tmpfs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 41/44] docs: filesystems: convert ubifs-authentication.rst.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` Mauro Carvalho Chehab [this message] 2020-02-17 16:12 ` [PATCH 42/44] docs: filesystems: convert ubifs.txt " Mauro Carvalho Chehab 2020-02-17 16:12 ` [PATCH 43/44] docs: filesystems: convert udf.txt " Mauro Carvalho Chehab 2020-02-18 7:12 ` Jan Kara 2020-02-18 10:13 ` Mauro Carvalho Chehab 2020-02-18 10:57 ` Jan Kara 2020-02-17 16:12 ` [PATCH 44/44] docs: filesystems: convert zonefs.txt " Mauro Carvalho Chehab 2020-02-18 3:46 ` Damien Le Moal 2020-02-18 4:01 ` [PATCH 00/44] Manually convert filesystem FS documents " Matthew Wilcox 2020-02-18 4:01 ` [Cluster-devel] " Matthew Wilcox 2020-02-18 4:01 ` Matthew Wilcox 2020-02-18 4:01 ` Matthew Wilcox 2020-02-18 4:01 ` [f2fs-dev] " Matthew Wilcox 2020-02-18 4:01 ` [Ocfs2-devel] " Matthew Wilcox 2020-02-18 10:04 ` Mauro Carvalho Chehab 2020-02-18 10:04 ` [Cluster-devel] " Mauro Carvalho Chehab 2020-02-18 10:04 ` Mauro Carvalho Chehab 2020-02-18 10:04 ` Mauro Carvalho Chehab 2020-02-18 10:04 ` [f2fs-dev] " Mauro Carvalho Chehab 2020-02-18 10:04 ` [Ocfs2-devel] " Mauro Carvalho Chehab 2020-02-19 9:32 ` Jonathan Corbet 2020-02-19 9:32 ` [Cluster-devel] " Jonathan Corbet 2020-02-19 9:32 ` Jonathan Corbet 2020-02-19 9:32 ` Jonathan Corbet 2020-02-19 9:32 ` [f2fs-dev] " Jonathan Corbet 2020-02-19 9:32 ` [Ocfs2-devel] " Jonathan Corbet 2020-02-19 15:11 ` Mauro Carvalho Chehab 2020-02-19 15:11 ` [Cluster-devel] " Mauro Carvalho Chehab 2020-02-19 15:11 ` Mauro Carvalho Chehab 2020-02-19 15:11 ` Mauro Carvalho Chehab 2020-02-19 15:11 ` [f2fs-dev] " Mauro Carvalho Chehab 2020-02-19 15:11 ` [Ocfs2-devel] " Mauro Carvalho Chehab 2020-03-02 21:13 ` Jonathan Corbet 2020-03-02 21:13 ` [Cluster-devel] " Jonathan Corbet 2020-03-02 21:13 ` Jonathan Corbet 2020-03-02 21:13 ` Jonathan Corbet 2020-03-02 21:13 ` [f2fs-dev] " Jonathan Corbet 2020-03-02 21:13 ` [Ocfs2-devel] " Jonathan Corbet
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=9043dc2965cafc64e6a521e2317c00ecc8303bf6.1581955849.git.mchehab+huawei@kernel.org \ --to=mchehab+huawei@kernel.org \ --cc=corbet@lwn.net \ --cc=linux-doc@vger.kernel.org \ --cc=linux-fsdevel@vger.kernel.org \ --cc=linux-mtd@lists.infradead.org \ --cc=richard@nod.at \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.