Document sections in the linker configuration file.

Author: dmsc

compiler/fastbasic-a5200.cfg

@@ -44,15 +44,25 @@ MEMORY {
 }
 
 SEGMENTS {
+    # Interpreter ZP variables
     ZEROPAGE:   load = ZP,                type = zp,  optional = yes;
+    # The jump-table of the interpreter
     JUMPTAB:    load = ROM,               type = ro,                  define = yes, align = $100;
+    # The interpreter functions
     RUNTIME:    load = ROM,               type = ro,                  define = yes;
+    # The program bytecode
     BYTECODE:   load = ROM,               type = ro,                  define = yes;
+    # Other (external) assembly code
     CODE:       load = ROM,               type = rw,                  define = yes;
+    # The interpreter main loop, copied to ZP.
     INTERP:     load = ROM, run = INTERP, type = rw,                  define = yes;
+    # The interpreter data, copied to RAM.
     DATA:       load = ROM, run = MAIN,   type = rw,                  define = yes;
+    # BSS, used for P/M graphics state
     BSS:        load = MAIN,              type = bss, optional = yes, define = yes;
+    # HEAP, used to store program variables
     HEAP:       load = MAIN,              type = bss, optional = yes, define = yes, align = $100;
+    # Cartridge information and headers
     CARTPAL:    load = CARTPAL,           type = ro;
     CARTNAME:   load = CARTNAME,          type = ro;
     CARTYEAR:   load = CARTYEAR,          type = ro;

compiler/fastbasic-cart.cfg

@@ -43,15 +43,25 @@ MEMORY {
 }
 
 SEGMENTS {
+    # Interpreter ZP variables
     ZEROPAGE: load = ZP,                type = zp,  optional = yes;
+    # The jump-table of the interpreter
     JUMPTAB:  load = ROM,               type = ro,                  define = yes, align = $100;
+    # The interpreter functions
     RUNTIME:  load = ROM,               type = ro,                  define = yes;
+    # The program bytecode
     BYTECODE: load = ROM,               type = ro,                  define = yes;
+    # Other (external) assembly code
     CODE:     load = ROM,               type = rw,                  define = yes;
+    # The interpreter main loop, copied to ZP.
     INTERP:   load = ROM, run = INTERP, type = rw,                  define = yes;
+    # The interpreter data, copied to RAM.
     DATA:     load = ROM, run = MAIN,   type = rw,                  define = yes;
+    # BSS, used for P/M graphics state
     BSS:      load = MAIN,              type = bss, optional = yes, define = yes;
+    # HEAP, used to store program variables
     HEAP:     load = MAIN,              type = bss, optional = yes, define = yes, align = $100;
+    # Cartridge header at the last 6 bytes
     CARTHDR:  load = CARTID,            type = ro;
 }
 

compiler/fastbasic.cfg

@@ -46,16 +46,28 @@ FORMATS {
 }
 
 SEGMENTS {
+    # Interpreter ZP variables
     ZEROPAGE: load = ZP,      type = zp,  optional = yes;
+    # ZP variables used by the IDE and compiler
     IDEZP:    load = ZP,      type = zp,  optional = yes;
+    # 4 bytes for the binary header written when compiling from the IDE
     PREHEAD:  load = PREMAIN, type = rw,  optional = yes, define = yes;
+    # The jump-table of the interpreter
     JUMPTAB:  load = MAIN,    type = ro,                  define = yes, align = $100;
+    # The interpreter functions
     RUNTIME:  load = MAIN,    type = rw,                  define = yes;
+    # The interpreter data
     DATA:     load = MAIN,    type = rw,                  define = yes;
+    # The program bytecode
     BYTECODE: load = MAIN,    type = rw,                  define = yes;
+    # This is only for the IDE, main IDE assembly code
     CODE:     load = MAIN,    type = rw,                  define = yes;
+    # Unused, available for including data that should be page aligned.
     ALIGNDATA:load = MAIN,    type = ro,  optional = yes, define = yes, align = $100;
+    # BSS, used for P/M graphics state
     BSS:      load = MAIN,    type = bss, optional = yes, define = yes;
+    # HEAP, used to store program variables
     HEAP:     load = MAIN,    type = bss, optional = yes, define = yes, align = $100;
+    # The interpreter main loop, loaded in ZP.
     INTERP:   load = INTERP,  type = rw;
 }