Skip to content

Commit a6b6f50

Browse files
ISSOtmgithub-actions[bot]
authored andcommitted
Update RGBDS master documentation
1 parent c8bcd8b commit a6b6f50

14 files changed

Lines changed: 56 additions & 53 deletions

‎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: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -379,15 +379,14 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
379379
<code class="Fl">-Wobsolete</code> enables the warning that
380380
<code class="Fl">-Wno-obsolete</code> disables; and
381381
<code class="Fl">-Wall</code> enables every warning that
382-
<code class="Fl">-Wno-all</code> disables). Only the non-default flag is
383-
listed here. Ignoring the &#x201C;no-&#x201D; prefix, entries are listed
384-
alphabetically.</p>
382+
<code class="Fl">-Wno-all</code> disables). The flags are listed
383+
alphabetically below.</p>
385384
<dl class="Bl-tag">
386-
<dt id="Wno-assert"><a class="permalink" href="#Wno-assert"><code class="Fl">-Wno-assert</code></a></dt>
385+
<dt id="Wassert"><a class="permalink" href="#Wassert"><code class="Fl">-Wassert</code></a></dt>
387386
<dd>Warn when <code class="Ic">WARN</code><span class="No">-type</span>
388387
assertions fail. (See &#x201C;Aborting the assembly process&#x201D; in
389388
<a class="Xr" href="./rgbasm.5">rgbasm(5)</a> for
390-
<code class="Ic">ASSERT</code>).</dd>
389+
<code class="Ic">ASSERT</code>). This warning is enabled by default.</dd>
391390
<dt id="Wbackwards-for"><a class="permalink" href="#Wbackwards-for"><code class="Fl">-Wbackwards-for</code></a></dt>
392391
<dd>Warn when <code class="Ic">FOR</code> loops have their start and stop
393392
values switched according to the step value. This warning is enabled by
@@ -416,21 +415,21 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
416415
<dt id="Wexport-undefined"><a class="permalink" href="#Wexport-undefined"><code class="Fl">-Wexport-undefined</code></a></dt>
417416
<dd>Warn when exporting an undefined symbol. This warning is enabled by
418417
<code class="Fl">-Wall</code>.</dd>
419-
<dt id="Wno-large-constant"><a class="permalink" href="#Wno-large-constant"><code class="Fl">-Wno-large-constant</code></a></dt>
418+
<dt id="Wlarge-constant"><a class="permalink" href="#Wlarge-constant"><code class="Fl">-Wlarge-constant</code></a></dt>
420419
<dd>Warn when a constant too large to fit in a signed 32-bit integer is
421-
encountered.</dd>
420+
encountered. This warning is enabled by default.</dd>
422421
<dt id="Wmacro-shift"><a class="permalink" href="#Wmacro-shift"><code class="Fl">-Wmacro-shift</code></a></dt>
423422
<dd>Warn when shifting macro arguments past their limits. This warning is
424423
enabled by <code class="Fl">-Wextra</code>.</dd>
425-
<dt id="Wno-nested-comment"><a class="permalink" href="#Wno-nested-comment"><code class="Fl">-Wno-nested-comment</code></a></dt>
424+
<dt id="Wnested-comment"><a class="permalink" href="#Wnested-comment"><code class="Fl">-Wnested-comment</code></a></dt>
426425
<dd>Warn when the block comment start sequence
427426
&#x2018;<code class="Li">/*</code>&#x2019; is found inside of a block
428427
comment. Block comments cannot be nested, so the first
429-
&#x2018;<code class="Li">*/</code>&#x2019; will end the whole
430-
comment.</dd>
431-
<dt id="Wno-obsolete"><a class="permalink" href="#Wno-obsolete"><code class="Fl">-Wno-obsolete</code></a></dt>
428+
&#x2018;<code class="Li">*/</code>&#x2019; will end the whole comment.
429+
This warning is enabled by default.</dd>
430+
<dt id="Wobsolete"><a class="permalink" href="#Wobsolete"><code class="Fl">-Wobsolete</code></a></dt>
432431
<dd>Warn when obsolete features are encountered, which have been deprecated
433-
and may later be removed.</dd>
432+
and may later be removed. This warning is enabled by default.</dd>
434433
<dt id="Wnumeric-string="><a class="permalink" href="#Wnumeric-string="><code class="Fl">-Wnumeric-string=</code></a></dt>
435434
<dd>Warn when a multi-character string is treated as a number.
436435
<code class="Fl">-Wnumeric-string=0</code> or
@@ -444,9 +443,11 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
444443
<dd>Warn when purging symbols which are likely to have been necessary.
445444
<code class="Fl">-Wpurge=0</code> or <code class="Fl">-Wno-purge</code>
446445
disables this warning. <code class="Fl">-Wpurge=1</code> warns when
447-
purging any exported symbol (regardless of type).
448-
<code class="Fl">-Wpurge=2</code> or just <code class="Fl">-Wpurge</code>
449-
also warns when purging any label (even if not exported).</dd>
446+
purging any exported symbol (regardless of type). This warning level is
447+
enabled by default. <code class="Fl">-Wpurge=2</code> or just
448+
<code class="Fl">-Wpurge</code> also warns when purging any label (even if
449+
not exported). This warning level is enabled by
450+
<code class="Fl">-Wall</code>.</dd>
450451
<dt id="Wshift"><a class="permalink" href="#Wshift"><code class="Fl">-Wshift</code></a></dt>
451452
<dd>Warn when shifting right a negative value. Use a division by 2**N
452453
instead.</dd>
@@ -458,18 +459,20 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
458459
or <code class="Fl">-Wno-truncation</code> disables this warning.
459460
<code class="Fl">-Wtruncation=1</code> or just
460461
<code class="Fl">-Wtruncation</code> warns when an N-bit value is 2**N or
461-
greater, or less than -2**N. <code class="Fl">-Wtruncation=2</code> also
462-
warns when an N-bit value is less than -2**(N-1), which will not fit in
463-
two's complement encoding.</dd>
462+
greater, or less than -2**N. This warning level is enabled by default.
463+
<code class="Fl">-Wtruncation=2</code> also warns when an N-bit value is
464+
less than -2**(N-1), which will not fit in two's complement encoding. This
465+
warning level is enabled by <code class="Fl">-Wextra</code>.</dd>
464466
<dt id="Wunmapped-char="><a class="permalink" href="#Wunmapped-char="><code class="Fl">-Wunmapped-char=</code></a></dt>
465467
<dd>Warn when a character goes through charmap conversion but has no defined
466468
mapping. <code class="Fl">-Wunmapped-char=0</code> or
467469
<code class="Fl">-Wno-unmapped-char</code> disables this warning.
468470
<code class="Fl">-Wunmapped-char=1</code> or just
469471
<code class="Fl">-Wunmapped-char</code> only warns if the active charmap
470-
is not empty. <code class="Fl">-Wunmapped-char=2</code> warns if the
471-
active charmap is empty, and/or is not the default charmap
472-
&#x2018;main&#x2019;.</dd>
472+
is not empty. This warning level is enabled by default.
473+
<code class="Fl">-Wunmapped-char=2</code> warns if the active charmap is
474+
empty, and/or is not the default charmap &#x2018;main&#x2019;. This
475+
warning level is enabled by <code class="Fl">-Wall</code>.</dd>
473476
<dt id="Wunmatched-directive"><a class="permalink" href="#Wunmatched-directive"><code class="Fl">-Wunmatched-directive</code></a></dt>
474477
<dd>Warn when a <code class="Ic">PUSHC</code>, <code class="Ic">PUSHO</code>,
475478
or <code class="Ic">PUSHS</code> directive does not have a corresponding
@@ -480,11 +483,11 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
480483
<dd>Warn when a <code class="Ic">LOAD</code> block is not terminated by an
481484
<code class="Ic">ENDL</code>. This warning is enabled by
482485
<code class="Fl">-Wextra</code>.</dd>
483-
<dt id="Wno-user"><a class="permalink" href="#Wno-user"><code class="Fl">-Wno-user</code></a></dt>
486+
<dt id="Wuser"><a class="permalink" href="#Wuser"><code class="Fl">-Wuser</code></a></dt>
484487
<dd>Warn when the <code class="Ic">WARN</code> built-in is executed. (See
485488
&#x201C;Aborting the assembly process&#x201D; in
486489
<a class="Xr" href="./rgbasm.5">rgbasm(5)</a> for
487-
<code class="Ic">WARN</code>).</dd>
490+
<code class="Ic">WARN</code>). This warning is enabled by default.</dd>
488491
</dl>
489492
</section>
490493
<section class="Sh">

‎docs/rgbasm.1.pdf‎

330 Bytes
Binary file not shown.

‎docs/rgbasm.5.pdf‎

0 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: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -283,23 +283,25 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
283283
<code class="Fl">-Wobsolete</code> enables the warning that
284284
<code class="Fl">-Wno-obsolete</code> disables; and
285285
<code class="Fl">-Wall</code> enables every warning that
286-
<code class="Fl">-Wno-all</code> disables). Only the non-default flag is
287-
listed here. Ignoring the &#x201C;no-&#x201D; prefix, entries are listed
288-
alphabetically.</p>
286+
<code class="Fl">-Wno-all</code> disables). The flags are listed
287+
alphabetically below.</p>
289288
<dl class="Bl-tag">
290-
<dt id="Wno-mbc"><a class="permalink" href="#Wno-mbc"><code class="Fl">-Wno-mbc</code></a></dt>
289+
<dt id="Wmbc"><a class="permalink" href="#Wmbc"><code class="Fl">-Wmbc</code></a></dt>
291290
<dd>Warn when there are inconsistencies with or caveats about the specified
292-
MBC type.</dd>
293-
<dt id="Wno-obsolete"><a class="permalink" href="#Wno-obsolete"><code class="Fl">-Wno-obsolete</code></a></dt>
291+
MBC type. This warning is enabled by default.</dd>
292+
<dt id="Wobsolete"><a class="permalink" href="#Wobsolete"><code class="Fl">-Wobsolete</code></a></dt>
294293
<dd>Warn when obsolete features are encountered, which have been deprecated
295-
and may later be removed.</dd>
296-
<dt id="Wno-overwrite"><a class="permalink" href="#Wno-overwrite"><code class="Fl">-Wno-overwrite</code></a></dt>
297-
<dd>Warn when overwriting different non-zero bytes in the header.</dd>
298-
<dt id="Wno-sgb"><a class="permalink" href="#Wno-sgb"><code class="Fl">-Wno-sgb</code></a></dt>
294+
and may later be removed. This warning is enabled by default.</dd>
295+
<dt id="Woverwrite"><a class="permalink" href="#Woverwrite"><code class="Fl">-Woverwrite</code></a></dt>
296+
<dd>Warn when overwriting different non-zero bytes in the header. This warning
297+
is enabled by default.</dd>
298+
<dt id="Wsgb"><a class="permalink" href="#Wsgb"><code class="Fl">-Wsgb</code></a></dt>
299299
<dd>Warn when the SGB flag (<code class="Fl">-s</code>) conflicts with the old
300-
licensee code (<code class="Fl">-l</code>).</dd>
301-
<dt id="Wno-truncation"><a class="permalink" href="#Wno-truncation"><code class="Fl">-Wno-truncation</code></a></dt>
302-
<dd>Warn when truncating values to fit the available space.</dd>
300+
licensee code (<code class="Fl">-l</code>). This warning is enabled by
301+
default.</dd>
302+
<dt id="Wtruncation"><a class="permalink" href="#Wtruncation"><code class="Fl">-Wtruncation</code></a></dt>
303+
<dd>Warn when truncating values to fit the available space. This warning is
304+
enabled by default.</dd>
303305
</dl>
304306
</section>
305307
<section class="Sh">

‎docs/rgbfix.1.pdf‎

106 Bytes
Binary file not shown.

‎docs/rgbgfx.1.html‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -807,18 +807,17 @@ <h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOS
807807
<code class="Fl">-Wobsolete</code> enables the warning that
808808
<code class="Fl">-Wno-obsolete</code> disables; and
809809
<code class="Fl">-Wall</code> enables every warning that
810-
<code class="Fl">-Wno-all</code> disables). Only the non-default flag is
811-
listed here. Ignoring the &#x201C;no-&#x201D; prefix, entries are listed
812-
alphabetically.</p>
810+
<code class="Fl">-Wno-all</code> disables). The flags are listed
811+
alphabetically below.</p>
813812
<dl class="Bl-tag">
814813
<dt id="Wembedded"><a class="permalink" href="#Wembedded"><code class="Fl">-Wembedded</code></a></dt>
815814
<dd>Warn when a generated palette is sorted according to the input PNG's
816815
embedded palette but <code class="Fl">-c</code>
817816
<code class="Cm">embedded</code> was not provided. This warning is enabled
818817
by <code class="Fl">-Weverything</code>.</dd>
819-
<dt id="Wno-obsolete"><a class="permalink" href="#Wno-obsolete"><code class="Fl">-Wno-obsolete</code></a></dt>
818+
<dt id="Wobsolete"><a class="permalink" href="#Wobsolete"><code class="Fl">-Wobsolete</code></a></dt>
820819
<dd>Warn when obsolete features are encountered, which have been deprecated
821-
and may later be removed.</dd>
820+
and may later be removed. This warning is enabled by default.</dd>
822821
<dt id="Wtrim-nonempty"><a class="permalink" href="#Wtrim-nonempty"><code class="Fl">-Wtrim-nonempty</code></a></dt>
823822
<dd>Warn when <code class="Fl">-x</code> trims a nonempty tile. An
824823
&quot;empty&quot; tile uses entirely color 0 of its palette. This warning

0 commit comments

Comments
 (0)