Update RGBDS master documentation

gbdev · Oct 16, 2024 · 52bb33c · 52bb33c
1 parent 62bab7e
commit 52bb33c
Show file tree

Hide file tree

Showing 11 changed files with 15 additions and 4 deletions.
diff --git a/docs/gbz80.7.pdf b/docs/gbz80.7.pdf
diff --git a/docs/rgbasm.1.html b/docs/rgbasm.1.html
@@ -333,6 +333,10 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
       is not empty. <code class="Fl">-Wunmapped-char=2</code> warns if the
       active charmap is empty, and/or is not the default charmap
       &#x2018;main&#x2019;.</dd>
+  <dt id="Wunterminated-load"><a class="permalink" href="#Wunterminated-load"><code class="Fl">-Wunterminated-load</code></a></dt>
+  <dd>Warn when a <code class="Ic">LOAD</code> block is not terminated by an
+      <code class="Ic">ENDL</code>. This warning is enabled by
+      <code class="Fl">-Wextra</code>.</dd>
   <dt id="Wno-user"><a class="permalink" href="#Wno-user"><code class="Fl">-Wno-user</code></a></dt>
   <dd>Warn when the <code class="Ic">WARN</code> built-in is executed. (See
       &#x201C;Aborting the assembly process&#x201D; in

diff --git a/docs/rgbasm.1.pdf b/docs/rgbasm.1.pdf
diff --git a/docs/rgbasm.5.html b/docs/rgbasm.5.html
@@ -1153,7 +1153,7 @@ <h3 class="Ss" id="RAM_code"><a class="permalink" href="#RAM_code">RAM
 CopyCode:
     ld de, RAMCode
     ld hl, RAMLocation
-    ld c, RAMLocation.end - RAMLocation
+    ld c, RAMCode.end - RAMCode
 .loop
     ld a, [de]
     inc de
@@ -1177,21 +1177,28 @@ <h3 class="Ss" id="RAM_code"><a class="permalink" href="#RAM_code">RAM
 
 .string
     db &quot;Hello World!\0&quot;
-.end
-  ENDL</pre>
+  ENDL
+.end</pre>
 </div>
 <p class="Pp">A <code class="Ic">LOAD</code> block feels similar to a
     <code class="Ic">SECTION</code> declaration because it creates a new one.
     All data and code generated within such a block is placed in the current
     section like usual, but all labels are created as if they were placed in
     this newly-created section.</p>
 <p class="Pp">In the example above, all of the code and data will end up in the
-    &quot;LOAD example&quot; section. You will notice the
+    &#x201C;LOAD example&#x201D; section. You will notice the
     &#x2018;RAMCode&#x2019; and &#x2018;RAMLocation&#x2019; labels. The former
     is situated in ROM, where the code is stored, the latter in RAM, where the
     code will be loaded.</p>
 <p class="Pp">You cannot nest <code class="Ic">LOAD</code> blocks, nor can you
     change or stop the current section within them.</p>
+<p class="Pp">The current <code class="Ic">LOAD</code> block can be ended by
+    using <code class="Ic">ENDL</code>. This directive is only necessary if you
+    want to resume writing code in its containing ROM section. Any of
+    <code class="Ic">LOAD</code>, <code class="Ic">SECTION</code>,
+    <code class="Ic">ENDSECTION</code>, or <code class="Ic">POPS</code> will end
+    the current <code class="Ic">LOAD</code> block before performing its own
+    function.</p>
 <p class="Pp"><code class="Ic">LOAD</code> blocks can use the
     <code class="Ic">UNION</code> or <code class="Ic">FRAGMENT</code> modifiers,
     as described below.</p>

diff --git a/docs/rgbasm.5.pdf b/docs/rgbasm.5.pdf
diff --git a/docs/rgbds.5.pdf b/docs/rgbds.5.pdf
diff --git a/docs/rgbds.7.pdf b/docs/rgbds.7.pdf
diff --git a/docs/rgbfix.1.pdf b/docs/rgbfix.1.pdf
diff --git a/docs/rgbgfx.1.pdf b/docs/rgbgfx.1.pdf
diff --git a/docs/rgblink.1.pdf b/docs/rgblink.1.pdf
diff --git a/docs/rgblink.5.pdf b/docs/rgblink.5.pdf