iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ext4: docs: switch away from list-table

Browse Source 
Commit 3a6541e97c03 (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>
This commit is contained in:
Jonathan Corbet 2021-09-02 16:08:53 -06:00
parent b19511926c
commit 91c76340b4
1 changed files with 11 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Documentation/filesystems/ext4/orphan.rst
View File

@ -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 (referenced from the superblock through s\_orphan_file_inum) with several
blocks. Each of these blocks has a structure: blocks. Each of these blocks has a structure:
.. list-table:: ============= ================ =============== ===============================
:widths: 8 8 24 40 Offset Type Name Description
:header-rows: 1 ============= ================ =============== ===============================
0x0 Array of Orphan inode Each \_\_le32 entry is either
* - Offset \_\_le32 entries entries empty (0) or it contains
- Type inode number of an orphan
- Name inode.
- Description blocksize-8 \_\_le32 ob\_magic Magic value stored in orphan
* - 0x0 block tail (0x0b10ca04)
- Array of \_\_le32 entries blocksize-4 \_\_le32 ob\_checksum Checksum of the orphan block.
- 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.
When a filesystem with orphan file feature is writeably mounted, we set When a filesystem with orphan file feature is writeably mounted, we set
RO\_COMPAT\_ORPHAN\_PRESENT feature in the superblock to indicate there may RO\_COMPAT\_ORPHAN\_PRESENT feature in the superblock to indicate there may