Skip to content

Commit

Permalink
ext4: docs: switch away from list-table
Browse files Browse the repository at this point in the history
Commit 3a6541e (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: Jan Kara <jack@suse.cz>
Link: https://lore.kernel.org/r/20210902220854.198850-2-corbet@lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Jonathan Corbet committed Oct 7, 2021
1 parent b195119 commit 91c7634
Showing 1 changed file with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions Documentation/filesystems/ext4/orphan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 91c7634

Please sign in to comment.