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

docs: filesystems: convert cramfs.txt to ReST 



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

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: default avatarNicolas Pitre <nico@fluxnic.net>
Link: https://lore.kernel.org/r/e87b267e71f99974b7bb3fc0a4a08454ff58165e.1581955849.git.mchehab+huawei@kernel.org


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

Documentation/filesystems/cramfs.txt→Documentation/filesystems/cramfs.rst

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



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

Cramfs - cram a filesystem onto a small ROM

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



cramfs is designed to be simple and small, and to compress things well.
@@ -28,9 +31,9 @@ issue. 
Hard links are supported, but hard linked files

will still have a link count of 1 in the cramfs image.



Cramfs directories have no `.' or `..' entries.  Directories (like

Cramfs directories have no ``.`` or ``..`` entries.  Directories (like

every other file on cramfs) always have a link count of 1.  (There's

no need to use -noleaf in `find', btw.)

no need to use -noleaf in ``find``, btw.)



No timestamps are stored in a cramfs, so these default to the epoch

(1970 GMT).  Recently-accessed files may have updated timestamps, but
@@ -70,7 +73,7 @@ MTD drivers are cfi_cmdset_0001 (Intel/Sharp CFI flash) or physmap 
(Flash device in physical memory map). MTD partitions based on such devices

are fine too. Then that device should be specified with the "mtd:" prefix

as the mount device argument. For example, to mount the MTD device named

"fs_partition" on the /mnt directory:

"fs_partition" on the /mnt directory::



    $ mount -t cramfs mtd:fs_partition /mnt
@@ -90,6 +93,7 @@ https://github.com/npitre/cramfs-tools 
For /usr/share/magic

--------------------



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

0	ulelong	0x28cd3d45	Linux cramfs offset 0

>4	ulelong	x		size %d

>8	ulelong	x		flags 0x%x
@@ -110,6 +114,7 @@ For /usr/share/magic 
>552	ulelong	x		fsid.blocks %d

>556	ulelong	x		fsid.files %d

>560	string	>\0		name "%.16s"

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





Hacker Notes

Documentation/filesystems/index.rst

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

   btrfs

   ceph

   cramfs

   fuse

   overlayfs

   virtiofs