From 6acf9849ab21348a0d2146288eefa349e3919221 Mon Sep 17 00:00:00 2001 From: Angie Date: Tue, 30 Apr 2024 17:50:25 -0400 Subject: [PATCH] start writing vram_classes docs --- docs/file_format/segments.md | 2 +- docs/file_format/vram_classes.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/file_format/vram_classes.md diff --git a/docs/file_format/segments.md b/docs/file_format/segments.md index 68deedd..c1b82d5 100644 --- a/docs/file_format/segments.md +++ b/docs/file_format/segments.md @@ -128,7 +128,7 @@ The name of another segment. If used then force putting the segment at address of the given vram class. -See the [`vram_class`](vram_class.md) docs for more info. +See the [`vram_classes`](vram_classes.md) docs for more info. It can't be used in combination with [`fixed_vram`](#fixed_vram), [`fixed_symbol`](#fixed_symbol) or [`follows_segment`](#follows_segment). diff --git a/docs/file_format/vram_classes.md b/docs/file_format/vram_classes.md new file mode 100644 index 0000000..5db5aab --- /dev/null +++ b/docs/file_format/vram_classes.md @@ -0,0 +1,16 @@ +# Vram classes + +Vram classes aim to help reduce duplicated data across the segments and more +clearly organize the memory layout. + +A vram class specifies a place in memory, which may be described in a somewhat +complex way, so one or more segments can point to this class instead of try to +describe the memory layout on the segment itself. + +## `name` + +## `fixed_vram` + +## `fixed_symbol` + +## `follow_classes`