diff options
| author | Felix Morgner <felix.morgner@gmail.com> | 2016-12-24 15:55:56 +0100 |
|---|---|---|
| committer | Felix Morgner <felix.morgner@gmail.com> | 2016-12-24 15:55:56 +0100 |
| commit | d6c74fdea16c70a93c70449317d75c5445c7522e (patch) | |
| tree | 2f801a3ea8fe49b21fd99836edd77ce2d0f26924 /doc/src/internal | |
| parent | 9b02e03c2a6f8a74a83dd40c69719fe36f4dd154 (diff) | |
| download | extfs-d6c74fdea16c70a93c70449317d75c5445c7522e.tar.xz extfs-d6c74fdea16c70a93c70449317d75c5445c7522e.zip | |
Update documentation
Diffstat (limited to 'doc/src/internal')
| -rw-r--r-- | doc/src/internal/index.rst | 7 | ||||
| -rw-r--r-- | doc/src/internal/superblock.rst | 42 |
2 files changed, 49 insertions, 0 deletions
diff --git a/doc/src/internal/index.rst b/doc/src/internal/index.rst new file mode 100644 index 0000000..4b7e2f7 --- /dev/null +++ b/doc/src/internal/index.rst @@ -0,0 +1,7 @@ +Internal Design +=============== + +.. toctree:: + :maxdepth: 1 + + superblock diff --git a/doc/src/internal/superblock.rst b/doc/src/internal/superblock.rst new file mode 100644 index 0000000..6e85df4 --- /dev/null +++ b/doc/src/internal/superblock.rst @@ -0,0 +1,42 @@ +The Superblock +============== + +The **superblock** of an ext2/3/4 file system describes the structure and +configuration of the file system. This information is used by the +implementation to determine the physical and logical structure of the file +system. This section describes the structure of the superblock itself. + +Definitions +----------- + +All fields described in this section are stored on the disk in little-endian +format, regardless of the system architecture. + +.. warning:: The implementation currently only works in little-endian + architectures. If you would like to get involved in implementing big-endian + support, please file an issue at the project repository over at + `Github <https://github.com/fmorgner/extfs>`_ + +The code in `Implementation`_ makes us of several :code:`using` directives to +reduce the amount of typing as well as make the code more readable. The +following aliases are declared in ``fs/detail/types.hpp``: + +.. doxygentypedef:: fs::detail::u32 +.. doxygentypedef:: fs::detail::s32 +.. doxygentypedef:: fs::detail::u16 +.. doxygentypedef:: fs::detail::s16 +.. doxygentypedef:: fs::detail::u08 +.. doxygentypedef:: fs::detail::u32_arr +.. doxygentypedef:: fs::detail::u08_arr +.. doxygentypedef:: fs::detail::chr_arr + +Structure +--------- + +.. todo:: Describe structure of the superblock + +Implementation +-------------- + +.. doxygenstruct:: fs::detail::extfs_superblock + :members: |
