Skip to content

Commit b5961ee

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent ac98ccd commit b5961ee

11 files changed

+16
-11
lines changed

docs/gbz80.7.pdf

0 Bytes
Binary file not shown.

docs/rgbasm.1.html

+7
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,13 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
291291
four characters, since four or fewer characters fit within a 32-bit
292292
integer. <code class="Fl">-Wnumeric-string=2</code> warns about any
293293
multi-character string.</dd>
294+
<dt id="Wpurge="><a class="permalink" href="#Wpurge="><code class="Fl">-Wpurge=</code></a></dt>
295+
<dd>Warn when purging symbols which are likely to have been necessary.
296+
<code class="Fl">-Wpurge=0</code> or <code class="Fl">-Wno-purge</code>
297+
disables this warning. <code class="Fl">-Wpurge=1</code> or just
298+
<code class="Fl">-Wpurge</code> warns when purging any exported symbol
299+
(regardless of type). <code class="Fl">-Wpurge=2</code> also warns when
300+
purging any label (even if not exported).</dd>
294301
<dt id="Wshift"><a class="permalink" href="#Wshift"><code class="Fl">-Wshift</code></a></dt>
295302
<dd>Warn when shifting right a negative value. Use a division by 2**N
296303
instead.</dd>

docs/rgbasm.1.pdf

377 Bytes
Binary file not shown.

docs/rgbasm.5.html

+9-11
Original file line numberDiff line numberDiff line change
@@ -1623,18 +1623,16 @@ <h3 class="Ss" id="Exporting_and_importing_symbols"><a class="permalink" href="#
16231623
<h3 class="Ss" id="Purging_symbols"><a class="permalink" href="#Purging_symbols">Purging
16241624
symbols</a></h3>
16251625
<p class="Pp"><code class="Ic">PURGE</code> allows you to completely remove a
1626-
symbol from the symbol table as if it had never existed.
1627-
<a class="permalink" href="#USE"><i class="Em" id="USE">USE WITH EXTREME
1628-
CAUTION</i></a>! I can't stress this enough,
1629-
<a class="permalink" href="#you"><b class="Sy" id="you">you seriously need
1630-
to know what you are doing</b></a>. DON'T purge a symbol that you use in
1631-
expressions the linker needs to calculate. When not sure, it's probably not
1632-
safe to purge anything other than variables, numeric or string constants, or
1633-
macros.</p>
1626+
symbol from the symbol table, as if it had never been defined. Be
1627+
<a class="permalink" href="#very"><i class="Em" id="very">very</i></a>
1628+
careful when purging symbols, especially labels, because it could result in
1629+
unpredictable errors if something depends on the missing symbol (for
1630+
example, expressions the linker needs to calculate).</p>
16341631
<div class="Bd Pp Bd-indent Li">
1635-
<pre>DEF Kamikaze EQUS &quot;I don't want to live anymore&quot;
1636-
DEF AOLer EQUS &quot;Me too&quot;
1637-
PURGE Kamikaze, AOLer</pre>
1632+
<pre>DEF Kamikaze EQUS &quot;I don't want to live anymore&quot;
1633+
AOLer: DB &quot;Me too lol&quot;
1634+
PURGE Kamikaze, AOLer
1635+
ASSERT !DEF(Kamikaze) &amp;&amp; !DEF(AOLer)</pre>
16381636
</div>
16391637
<p class="Pp">String constants are not expanded within the symbol names.</p>
16401638
</section>

docs/rgbasm.5.pdf

-150 Bytes
Binary file not shown.

docs/rgbds.5.pdf

0 Bytes
Binary file not shown.

docs/rgbds.7.pdf

0 Bytes
Binary file not shown.

docs/rgbfix.1.pdf

0 Bytes
Binary file not shown.

docs/rgbgfx.1.pdf

0 Bytes
Binary file not shown.

docs/rgblink.1.pdf

0 Bytes
Binary file not shown.

docs/rgblink.5.pdf

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)