Commit de7abd7b authored by Darrick J. Wong's avatar Darrick J. Wong Committed by Theodore Ts'o
Browse files

docs: fix ext4 documentation table formatting problems 



It turns out that the latex table formatters lay out table columns with
the exact proportional widths given in the table metadata, even if text
overflows outside the box.  This was not caught during the initial
import because the HTML renderers are smart enough to fudge the table.

Fix the table column width formatting problems in the data structures
and algorithms documentation so that we don't have squashed columns.

Signed-off-by: default avatarDarrick J. Wong <darrick.wong@oracle.com>
Signed-off-by: default avatarTheodore Ts'o <tytso@mit.edu>
parent e5f09261

Documentation/filesystems/ext4/ondisk/attributes.rst

+4 −4
Original line number Diff line number Diff line
@@ -30,7 +30,7 @@ Extended attributes, when stored after the inode, have a header 
``ext4_xattr_ibody_header`` that is 4 bytes long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -47,7 +47,7 @@ The beginning of an extended attribute block is in 
``struct ext4_xattr_header``, which is 32 bytes long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -92,7 +92,7 @@ entries must be stored in sorted order. The sort order is 
Attributes stored inside an inode do not need be stored in sorted order.



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -157,7 +157,7 @@ attribute name index field is set, and matching string is removed from 
the key name. Here is a map of name index values to key prefixes:



.. list-table::

   :widths: 1 79

   :widths: 16 64

   :header-rows: 1



   * - Name Index

Documentation/filesystems/ext4/ondisk/checksums.rst

+1 −1
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ of checksum. The checksum function is whatever the superblock describes 
(crc32c as of October 2013) unless noted otherwise.



.. list-table::

   :widths: 1 1 4

   :widths: 20 8 50

   :header-rows: 1



   * - Metadata

Documentation/filesystems/ext4/ondisk/directory.rst

+9 −9
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ is at most 263 bytes long, though on disk you'll need to reference 
``dirent.rec_len`` to know for sure.



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -66,7 +66,7 @@ tree traversal. This format is ``ext4_dir_entry_2``, which is at most 
``dirent.rec_len`` to know for sure.



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -99,7 +99,7 @@ tree traversal. This format is ``ext4_dir_entry_2``, which is at most 
The directory file type is one of the following values:



.. list-table::

   :widths: 1 79

   :widths: 16 64

   :header-rows: 1



   * - Value
@@ -130,7 +130,7 @@ in the place where the name normally goes. The structure is 
``struct ext4_dir_entry_tail``:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -212,7 +212,7 @@ The root of the htree is in ``struct dx_root``, which is the full length 
of a data block:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -305,7 +305,7 @@ of a data block: 
The directory hash is one of the following values:



.. list-table::

   :widths: 1 79

   :widths: 16 64

   :header-rows: 1



   * - Value
@@ -327,7 +327,7 @@ Interior nodes of an htree are recorded as ``struct dx_node``, which is 
also the full length of a data block:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -375,7 +375,7 @@ The hash maps that exist in both ``struct dx_root`` and 
long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -405,7 +405,7 @@ directory index (which will ensure that there's space for the checksum. 
The dx\_tail structure is 8 bytes long and looks like this:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset

Documentation/filesystems/ext4/ondisk/group_descr.rst

+2 −2
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ entire bitmap. 
The block group descriptor is laid out in ``struct ext4_group_desc``.



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -157,7 +157,7 @@ The block group descriptor is laid out in ``struct ext4_group_desc``. 
Block group flags can be any combination of the following:



.. list-table::

   :widths: 1 79

   :widths: 16 64

   :header-rows: 1



   * - Value

Documentation/filesystems/ext4/ondisk/ifork.rst

+4 −4
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ The extent tree header is recorded in ``struct ext4_extent_header``, 
which is 12 bytes long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -104,7 +104,7 @@ Internal nodes of the extent tree, also known as index nodes, are 
recorded as ``struct ext4_extent_idx``, and are 12 bytes long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -134,7 +134,7 @@ Leaf nodes of the extent tree are recorded as ``struct ext4_extent``, 
and are also 12 bytes long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset
@@ -174,7 +174,7 @@ including) the checksum itself. 
``struct ext4_extent_tail`` is 4 bytes long:



.. list-table::

   :widths: 1 1 1 77

   :widths: 8 8 24 40

   :header-rows: 1



   * - Offset

CRA Git | Maintained and supported by SUSTech CRA and CCSE