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

docs: filesystems: convert omfs.txt to ReST 



- Add a SPDX header;
- Adjust document title;
- 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 avatarBob Copeland <me@bobcopeland.com>
Link: https://lore.kernel.org/r/0c125c7c971d81a557ca954992b8d770a9d1e3e8.1581955849.git.mchehab+huawei@kernel.org


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

Documentation/filesystems/index.rst

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

   ocfs2

   ocfs2-online-filecheck

   omfs

   overlayfs

   virtiofs

   vfat

Documentation/filesystems/omfs.txt→Documentation/filesystems/omfs.rst

+112 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



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

Optimized MPEG Filesystem (OMFS)

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



Overview

========
@@ -29,11 +33,13 @@ Options 


OMFS supports the following mount-time options:



    uid=n        - make all files owned by specified user

    gid=n        - make all files owned by specified group

    umask=xxx    - set permission umask to xxx

    fmask=xxx    - set umask to xxx for files

    dmask=xxx    - set umask to xxx for directories

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

    uid=n          make all files owned by specified user

    gid=n          make all files owned by specified group

    umask=xxx      set permission umask to xxx

    fmask=xxx      set umask to xxx for files

    dmask=xxx      set umask to xxx for directories

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



Disk format

===========
@@ -46,7 +52,7 @@ have a smaller size than a data block, but since they are both addressed by the 
same 64-bit block number, any remaining space in the smaller sysblock is

unused.



Sysblock header information:

Sysblock header information::



    struct omfs_header {

	    __be64 h_self;                  /* FS block where this is located */
@@ -60,7 +66,7 @@ struct omfs_header { 
	    __be32 h_fill2;

    };



Files and directories are both represented by omfs_inode:

Files and directories are both represented by omfs_inode::



    struct omfs_inode {

	    struct omfs_header i_head;      /* header */
@@ -82,7 +88,7 @@ until a match is found on i_name. Empty buckets are represented by block 
pointers with all-1s (~0).



A file is an omfs_inode structure followed by an extent table beginning at

OMFS_EXTENT_START:

OMFS_EXTENT_START::



    struct omfs_extent_entry {

	    __be64 e_cluster;               /* start location of a set of blocks */

CRA Git | Maintained and supported by SUSTech CRA and CCSE