Skip to content

Commit

Permalink
start writing vram_classes docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AngheloAlf committed Apr 30, 2024
1 parent 8b2948c commit 6acf984
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/file_format/segments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
16 changes: 16 additions & 0 deletions docs/file_format/vram_classes.md
Original file line number Diff line number Diff line change
@@ -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`

0 comments on commit 6acf984

Please sign in to comment.