Skip to content

Commit 4e72b65

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent aa9fea3 commit 4e72b65

File tree

13 files changed

+12
-53
lines changed

13 files changed

+12
-53
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.pdf

0 Bytes
Binary file not shown.

docs/rgbasm.5.html

Lines changed: 5 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -938,50 +938,6 @@ <h3 class="Ss" id="String_expressions"><a class="permalink" href="#String_expres
938938
string are counted by &#x2018;<code class="Li">CHARLEN</code>&#x2019;; and
939939
the values of a charmap entry are counted by
940940
&#x2018;<code class="Li">CHARSIZE</code>&#x2019;.</p>
941-
<p class="Pp" id="position">The following legacy functions are similar to other
942-
functions that operate on string expressions, but for historical reasons,
943-
they count starting from
944-
<a class="permalink" href="#position"><i class="Em">position 1</i></a>, not
945-
from index 0! (Position -1 still counts from the end.)</p>
946-
<table class="Bl-column">
947-
<tr id="Name~5">
948-
<td><a class="permalink" href="#Name~5"><b class="Sy">Name</b></a></td>
949-
<td><a class="permalink" href="#Operation~5"><b class="Sy" id="Operation~5">Operation</b></a></td>
950-
</tr>
951-
<tr id="STRSUB">
952-
<td><a class="permalink" href="#STRSUB"><code class="Fn">STRSUB</code></a>(<var class="Fa">str</var>,
953-
<var class="Fa">pos</var>, <var class="Fa">len</var>)</td>
954-
<td>Returns a substring of <var class="Ar">str</var>
955-
<span class="No">starting at</span> <var class="Ar">pos</var>
956-
<span class="No">and</span> <var class="Ar">len</var>
957-
<span class="No">characters long. If</span> <var class="Ar">len</var>
958-
<span class="No">is not specified, the substring continues to the end
959-
of</span> <var class="Ar">str</var> .</td>
960-
</tr>
961-
<tr id="STRIN">
962-
<td><a class="permalink" href="#STRIN"><code class="Fn">STRIN</code></a>(<var class="Fa">str</var>,
963-
<var class="Fa">sub</var>)</td>
964-
<td>Returns the first position of <var class="Ar">sub</var>
965-
<span class="No">in</span> <var class="Ar">str</var>, or 0 if it's not
966-
present.</td>
967-
</tr>
968-
<tr id="STRRIN">
969-
<td><a class="permalink" href="#STRRIN"><code class="Fn">STRRIN</code></a>(<var class="Fa">str</var>,
970-
<var class="Fa">sub</var>)</td>
971-
<td>Returns the last position of <var class="Ar">sub</var>
972-
<span class="No">in</span> <var class="Ar">str</var>, or 0 if it's not
973-
present.</td>
974-
</tr>
975-
<tr id="CHARSUB">
976-
<td><a class="permalink" href="#CHARSUB"><code class="Fn">CHARSUB</code></a>(<var class="Fa">str</var>,
977-
<var class="Fa">pos</var>)</td>
978-
<td>Returns the substring of <var class="Ar">str</var> <span class="No">for
979-
the charmap entry at</span> <var class="Ar">pos</var>
980-
<span class="No">with the current charmap</span>.
981-
(<var class="Ar">pos</var> <span class="No">counts charmap entries, not
982-
characters.</span>)</td>
983-
</tr>
984-
</table>
985941
</section>
986942
<section class="Ss">
987943
<h3 class="Ss" id="Character_maps"><a class="permalink" href="#Character_maps">Character
@@ -1063,9 +1019,9 @@ <h3 class="Ss" id="Other_functions"><a class="permalink" href="#Other_functions"
10631019
<p class="Pp">There are a few other functions that do things beyond numeric or
10641020
string operations:</p>
10651021
<table class="Bl-column">
1066-
<tr id="Name~6">
1067-
<td><a class="permalink" href="#Name~6"><b class="Sy">Name</b></a></td>
1068-
<td><a class="permalink" href="#Operation~6"><b class="Sy" id="Operation~6">Operation</b></a></td>
1022+
<tr id="Name~5">
1023+
<td><a class="permalink" href="#Name~5"><b class="Sy">Name</b></a></td>
1024+
<td><a class="permalink" href="#Operation~5"><b class="Sy" id="Operation~5">Operation</b></a></td>
10691025
</tr>
10701026
<tr id="DEF">
10711027
<td><a class="permalink" href="#DEF"><code class="Fn">DEF</code></a>(<var class="Fa">symbol</var>)</td>
@@ -1970,8 +1926,8 @@ <h3 class="Ss" id="Predeclared_symbols"><a class="permalink" href="#Predeclared_
19701926
symbols</a></h3>
19711927
<p class="Pp">The following symbols are defined by the assembler:</p>
19721928
<table class="Bl-column Bd-indent">
1973-
<tr id="Name~7">
1974-
<td><a class="permalink" href="#Name~7"><b class="Sy">Name</b></a></td>
1929+
<tr id="Name~6">
1930+
<td><a class="permalink" href="#Name~6"><b class="Sy">Name</b></a></td>
19751931
<td><a class="permalink" href="#Type~2"><b class="Sy" id="Type~2">Type</b></a></td>
19761932
<td><a class="permalink" href="#Contents"><b class="Sy" id="Contents">Contents</b></a></td>
19771933
</tr>

docs/rgbasm.5.pdf

-718 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.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a><
33
<table class="Nm">
44
<tr>
55
<td><code class="Nm">rgbfix</code></td>
6-
<td>[<code class="Fl"><a href="#h">-h</a><a href="#j">j</a><a href="#O">O</a><a href="#s">s</a><a href="#V">V</a><a href="#v">v</a><a href="#w">w</a></code>] [<code class="Fl"><a href="#C">-C</a></code> |
6+
<td>[<code class="Fl"><a href="#h">-h</a><a href="#j">j</a><a href="#s">s</a><a href="#V">V</a><a href="#v">v</a><a href="#w">w</a></code>] [<code class="Fl"><a href="#C">-C</a></code> |
77
<code class="Fl"><a href="#c">-c</a></code>] [<code class="Fl">--color</code>
88
<var class="Ar">when</var>] [<code class="Fl"><a href="#f">-f</a></code>
99
<var class="Ar">fix_spec</var>] [<code class="Fl"><a href="#i">-i</a></code>
@@ -139,9 +139,6 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
139139
<var class="Ar">rom_version</var></dt>
140140
<dd>Set the ROM version (<span class="Ad">0x14C</span>) to a given value from
141141
0 to 0xFF.</dd>
142-
<dt id="O"><a class="permalink" href="#O"><code class="Fl">-O</code></a>,
143-
<code class="Fl">--overwrite</code></dt>
144-
<dd>Alias for <code class="Fl">-Wno-overwrite</code>.</dd>
145142
<dt id="o"><a class="permalink" href="#o"><code class="Fl">-o</code></a>
146143
<var class="Ar">out_file</var>, <code class="Fl">--output</code>
147144
<var class="Ar">out_file</var></dt>
@@ -237,6 +234,9 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
237234
<dt id="Wno-mbc"><a class="permalink" href="#Wno-mbc"><code class="Fl">-Wno-mbc</code></a></dt>
238235
<dd>Warn when there are inconsistencies with or caveats about the specified
239236
MBC type.</dd>
237+
<dt id="Wno-obsolete"><a class="permalink" href="#Wno-obsolete"><code class="Fl">-Wno-obsolete</code></a></dt>
238+
<dd>Warn when obsolete features are encountered, which have been deprecated
239+
and may later be removed.</dd>
240240
<dt id="Wno-overwrite"><a class="permalink" href="#Wno-overwrite"><code class="Fl">-Wno-overwrite</code></a></dt>
241241
<dd>Warn when overwriting different non-zero bytes in the header.</dd>
242242
<dt id="Wno-sgb"><a class="permalink" href="#Wno-sgb"><code class="Fl">-Wno-sgb</code></a></dt>

docs/rgbfix.1.pdf

16 Bytes
Binary file not shown.

docs/rgbgfx.1.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -800,6 +800,9 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
800800
embedded palette but <code class="Fl">-c</code>
801801
<code class="Cm">embedded</code> was not provided. This warning is enabled
802802
by <code class="Fl">-Weverything</code>.</dd>
803+
<dt id="Wno-obsolete"><a class="permalink" href="#Wno-obsolete"><code class="Fl">-Wno-obsolete</code></a></dt>
804+
<dd>Warn when obsolete features are encountered, which have been deprecated
805+
and may later be removed.</dd>
803806
<dt id="Wtrim-nonempty"><a class="permalink" href="#Wtrim-nonempty"><code class="Fl">-Wtrim-nonempty</code></a></dt>
804807
<dd>Warn when <code class="Fl">-x</code> trims a nonempty tile. An
805808
&quot;empty&quot; tile uses entirely color 0 of its palette. This warning

0 commit comments

Comments
 (0)