Skip to content

Commit c9b5cd4

Browse files
committed
multiboot2-common: doc fixes
1 parent 37a2aa0 commit c9b5cd4

File tree

5 files changed

+104
-71
lines changed

5 files changed

+104
-71
lines changed

multiboot2-common/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,13 @@ safely cast to the target type.
2525
![Generic parsing flow overview](./parsing-flow-generic.drawio.png "Generic parsing flow overview: From raw bytes to specific structures")
2626

2727
The next figure is like the previous figure, but shows a more specific parsing
28-
flow by using types of the `multiboot2` crate. Green shows the raw memory.
29-
Purple boxes refers to logic in `multiboot2-common`. Red components show structs
30-
from the `multiboot2` crate.
28+
flow by using example types of the `multiboot2` crate. Specifically, it shows
29+
how the header structs for each multiboot2 structure, each implementing
30+
the `Header` trait, are utilized as generic types to get the right size
31+
information of the final type tag type.
32+
33+
Green shows the raw memory, purple boxes refer to logic in `multiboot2-common`,
34+
and red components show structs from the `multiboot2` crate.
3135

3236
![Specific parsing flow overview](./parsing-flow-specific.drawio.png "Specific parsing flow overview: From raw bytes to multiboot2 structures")
3337

Loading

0 commit comments

Comments
 (0)