Commit 91c76340 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

ext4: docs: switch away from list-table 



Commit 3a6541e9 (Add documentation about the orphan file feature) added
a new document on orphan files, which is great.  But the use of
"list-table" results in documents that are absolutely unreadable in their
plain-text form.  Switch this file to the regular RST table format instead;
the rendered (HTML) output is identical.

Reviewed-by: default avatarJan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/20210902220854.198850-2-corbet@lwn.net


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

Documentation/filesystems/ext4/orphan.rst

+11 −21
Original line number Diff line number Diff line
@@ -21,27 +21,17 @@ in heavy creation of orphan inodes. When orphan file feature 
(referenced from the superblock through s\_orphan_file_inum) with several

blocks. Each of these blocks has a structure:



.. list-table::

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset

     - Type

     - Name

     - Description

   * - 0x0

     - Array of \_\_le32 entries

     - Orphan inode entries

     - Each \_\_le32 entry is either empty (0) or it contains inode number of

       an orphan inode.

   * - blocksize - 8

     - \_\_le32

     - ob\_magic

     - Magic value stored in orphan block tail (0x0b10ca04)

   * - blocksize - 4

     - \_\_le32

     - ob\_checksum

     - Checksum of the orphan block.

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

Offset        Type             Name            Description

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

0x0           Array of         Orphan inode    Each \_\_le32 entry is either

              \_\_le32 entries entries         empty (0) or it contains

	                                       inode number of an orphan

					       inode.

blocksize-8   \_\_le32         ob\_magic       Magic value stored in orphan

                                               block tail (0x0b10ca04)

blocksize-4   \_\_le32         ob\_checksum    Checksum of the orphan block.

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



When a filesystem with orphan file feature is writeably mounted, we set

RO\_COMPAT\_ORPHAN\_PRESENT feature in the superblock to indicate there may