Skip to content

Commit b9e8a2f

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent 4979722 commit b9e8a2f

File tree

13 files changed

+29
-23
lines changed

13 files changed

+29
-23
lines changed

docs/gbz80.7.pdf

0 Bytes
Binary file not shown.

docs/rgbasm-old.5.pdf

0 Bytes
Binary file not shown.

docs/rgbasm.1.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -384,10 +384,10 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
384384
<dt id="Wpurge="><a class="permalink" href="#Wpurge="><code class="Fl">-Wpurge=</code></a></dt>
385385
<dd>Warn when purging symbols which are likely to have been necessary.
386386
<code class="Fl">-Wpurge=0</code> or <code class="Fl">-Wno-purge</code>
387-
disables this warning. <code class="Fl">-Wpurge=1</code> or just
388-
<code class="Fl">-Wpurge</code> warns when purging any exported symbol
389-
(regardless of type). <code class="Fl">-Wpurge=2</code> also warns when
390-
purging any label (even if not exported).</dd>
387+
disables this warning. <code class="Fl">-Wpurge=1</code> warns when
388+
purging any exported symbol (regardless of type).
389+
<code class="Fl">-Wpurge=2</code> or just <code class="Fl">-Wpurge</code>
390+
also warns when purging any label (even if not exported).</dd>
391391
<dt id="Wshift"><a class="permalink" href="#Wshift"><code class="Fl">-Wshift</code></a></dt>
392392
<dd>Warn when shifting right a negative value. Use a division by 2**N
393393
instead.</dd>
@@ -397,11 +397,11 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
397397
<dd>Warn when an implicit truncation (for example, <code class="Ic">db</code>
398398
to an 8-bit value) loses some bits. <code class="Fl">-Wtruncation=0</code>
399399
or <code class="Fl">-Wno-truncation</code> disables this warning.
400-
<code class="Fl">-Wtruncation=1</code> warns when an N-bit value is 2**N
401-
or greater, or less than -2**N. <code class="Fl">-Wtruncation=2</code> or
402-
just <code class="Fl">-Wtruncation</code> also warns when an N-bit value
403-
is less than -2**(N-1), which will not fit in two's complement
404-
encoding.</dd>
400+
<code class="Fl">-Wtruncation=1</code> or just
401+
<code class="Fl">-Wtruncation</code> warns when an N-bit value is 2**N or
402+
greater, or less than -2**N. <code class="Fl">-Wtruncation=2</code> also
403+
warns when an N-bit value is less than -2**(N-1), which will not fit in
404+
two's complement encoding.</dd>
405405
<dt id="Wunmapped-char="><a class="permalink" href="#Wunmapped-char="><code class="Fl">-Wunmapped-char=</code></a></dt>
406406
<dd>Warn when a character goes through charmap conversion but has no defined
407407
mapping. <code class="Fl">-Wunmapped-char=0</code> or

docs/rgbasm.1.pdf

-3 Bytes
Binary file not shown.

docs/rgbasm.5.html

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1922,17 +1922,23 @@ <h3 class="Ss" id="Exporting_and_importing_symbols"><a class="permalink" href="#
19221922
<h3 class="Ss" id="Purging_symbols"><a class="permalink" href="#Purging_symbols">Purging
19231923
symbols</a></h3>
19241924
<p class="Pp"><code class="Ic">PURGE</code> allows you to completely remove a
1925-
symbol from the symbol table, as if it had never been defined. Be
1926-
<a class="permalink" href="#very"><i class="Em" id="very">very</i></a>
1927-
careful when purging symbols, especially labels, because it could result in
1928-
unpredictable errors if something depends on the missing symbol (for
1929-
example, expressions the linker needs to calculate).</p>
1925+
symbol from the symbol table, as if it had never been defined.</p>
19301926
<div class="Bd Pp Bd-indent Li">
1931-
<pre>DEF Kamikaze EQUS &quot;I don't want to live anymore&quot;
1932-
AOLer: DB &quot;Me too lol&quot;
1933-
PURGE Kamikaze, AOLer
1934-
ASSERT !DEF(Kamikaze) &amp;&amp; !DEF(AOLer)</pre>
1927+
<pre>DEF value EQU 42
1928+
PURGE value
1929+
DEF value EQUS &quot;I'm a string now&quot;
1930+
ASSERT DEF(value)
1931+
PURGE value
1932+
ASSERT !DEF(value)</pre>
19351933
</div>
1934+
<p class="Pp" id="very">Be
1935+
<a class="permalink" href="#very"><i class="Em">very</i></a> careful when
1936+
purging symbols that have been referenced in section data, or that have been
1937+
exported, because it could result in unpredictable errors if something
1938+
depends on the missing symbol (for example, expressions the linker needs to
1939+
calculate). Purging labels at all is
1940+
<a class="permalink" href="#not"><i class="Em" id="not">not</i></a>
1941+
recommended.</p>
19361942
<p class="Pp">String constants are not expanded within the symbol names.</p>
19371943
</section>
19381944
<section class="Ss">

docs/rgbasm.5.pdf

-26 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.

0 commit comments

Comments
 (0)