aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2021-06-24 22:12:51 +0100
committerJuan J. Martinez <jjm@usebox.net>2021-06-24 22:12:51 +0100
commit148d72e795264d39d3b49d1d429e252ff74f0e23 (patch)
treee284f09ddf48afa25b6961dd09f08b02200f72c2 /docs
parentfe20bafc80cba5a5a0363aaa2b4b60b2e68bde85 (diff)
downloadubox-msx-lib-148d72e795264d39d3b49d1d429e252ff74f0e23.tar.gz
ubox-msx-lib-148d72e795264d39d3b49d1d429e252ff74f0e23.zip
Documented chksize
Diffstat (limited to 'docs')
-rw-r--r--docs/tools.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/tools.md b/docs/tools.md
index 79c181d..83f80f3 100644
--- a/docs/tools.md
+++ b/docs/tools.md
@@ -200,7 +200,28 @@ Refer to the example game and `init_map_entities()` in `game.c` for a full examp
### chksize
-TODO
+This tool is used to calculate how much much space in the DATA and CODE
+sections is used by the game.
+
+It takes three parameters:
+
+- the CODE limit (in hexadecimal)
+- the DATA limit (in hexadecimal)
+- the map file (output of SDCC)
+
+For example:
+```
+chksize 8000 4000 game.map
+```
+
+Has the output:
+```
+ROM: 11430 bytes
+RAM: 01256 bytes
+```
+
+If the CODE (ROM) or the DATA (RAM) is over the provided limits, the tool will
+report it with an error.
### mkdeps.py