Skip to content

Commit c8ed50d

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent e3da744 commit c8ed50d

12 files changed

Lines changed: 67 additions & 1 deletion

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

0 Bytes
Binary file not shown.

docs/rgbgfx.1.html

Lines changed: 62 additions & 1 deletion
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">rgbgfx</code></td>
6-
<td>[<code class="Fl"><a href="#C">-C</a><a href="#m">m</a><a href="#h">h</a><a href="#O">O</a><a href="#u">u</a><a href="#V">V</a><a href="#X">X</a><a href="#Y">Y</a><a href="#Z">Z</a></code>] [<code class="Fl"><a href="#v">-v</a></code>
6+
<td>[<code class="Fl"><a href="#C">-C</a><a href="#m">m</a><a href="#h">h</a><a href="#O">O</a><a href="#u">u</a><a href="#V">V</a><a href="#w">w</a><a href="#X">X</a><a href="#Y">Y</a><a href="#Z">Z</a></code>] [<code class="Fl"><a href="#v">-v</a></code>
77
[<code class="Fl"><a href="#v">-v</a></code> <span class="No">...</span>]]
88
[<code class="Fl"><a href="#a">-a</a></code> <var class="Ar">attrmap</var> |
99
<code class="Fl"><a href="#A">-A</a></code>] [<code class="Fl"><a href="#b">-b</a></code>
@@ -22,6 +22,7 @@ <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a><
2222
<var class="Ar">width</var>] [<code class="Fl"><a href="#s">-s</a></code>
2323
<var class="Ar">nb_colors</var>] [<code class="Fl"><a href="#t">-t</a></code>
2424
<var class="Ar">tilemap</var> | <code class="Fl"><a href="#T">-T</a></code>]
25+
[<code class="Fl"><a href="#W">-W</a></code> <var class="Ar">warning</var>]
2526
[<code class="Fl"><a href="#x">-x</a></code> <var class="Ar">quantity</var>]
2627
<var class="Ar">file</var></td>
2728
</tr>
@@ -374,6 +375,15 @@ <h2 class="Sh" id="ARGUMENTS"><a class="permalink" href="#ARGUMENTS">ARGUMENTS</
374375
humans, and may change without notice between RGBDS releases; relying on
375376
those for scripts is not advised.</p>
376377
</dd>
378+
<dt id="W"><a class="permalink" href="#W"><code class="Fl">-W</code></a>
379+
<var class="Ar">warning</var>, <code class="Fl">--warning</code>
380+
<var class="Ar">warning</var></dt>
381+
<dd>Set warning flag <var class="Ar">warning</var>. A warning message will be
382+
printed if <var class="Ar">warning</var> is an unknown warning flag. See
383+
the <a class="Sx" href="#DIAGNOSTICS">DIAGNOSTICS</a> section for a list
384+
of warnings.</dd>
385+
<dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a></dt>
386+
<dd>Disable all warning output, even when turned into errors.</dd>
377387
<dt id="X"><a class="permalink" href="#X"><code class="Fl">-X</code></a>,
378388
<code class="Fl">--mirror-x</code></dt>
379389
<dd>Deduplicate tiles that are horizontally symmetrical mirror images of each
@@ -718,6 +728,57 @@ <h2 class="Sh" id="REVERSE_MODE"><a class="permalink" href="#REVERSE_MODE">REVER
718728
</table>
719729
</section>
720730
<section class="Sh">
731+
<h2 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h2>
732+
<p class="Pp">Warnings are diagnostic messages that indicate possibly erroneous
733+
behavior that does not necessarily compromise the conversion process. The
734+
following options alter the way warnings are processed.</p>
735+
<dl class="Bl-tag">
736+
<dt id="Werror"><a class="permalink" href="#Werror"><code class="Fl">-Werror</code></a></dt>
737+
<dd>Make all warnings into errors. This can be negated as
738+
<code class="Fl">-Wno-error</code> to prevent turning all warnings into
739+
errors.</dd>
740+
<dt id="Werror="><a class="permalink" href="#Werror="><code class="Fl">-Werror=</code></a></dt>
741+
<dd>Make the specified warning or meta warning into an error. A warning's name
742+
is appended (example: <code class="Fl">-Werror=embedded</code>), and this
743+
warning is implicitly enabled and turned into an error. This can be
744+
negated as <code class="Fl">-Wno-error=</code> to prevent turning a
745+
specified warning into an error, even if <code class="Fl">-Werror</code>
746+
is in effect.</dd>
747+
</dl>
748+
<p class="Pp">The following warnings are &#x201C;meta&#x201D; warnings, that
749+
enable a collection of other warnings. If a specific warning is toggled via
750+
a meta flag and a specific one, the more specific one takes priority. The
751+
position on the command-line acts as a tie breaker, the last one taking
752+
effect.</p>
753+
<dl class="Bl-tag">
754+
<dt id="Wall"><a class="permalink" href="#Wall"><code class="Fl">-Wall</code></a></dt>
755+
<dd>This enables warnings that are likely to indicate an error or undesired
756+
behavior, and that can easily be fixed.</dd>
757+
<dt id="Weverything"><a class="permalink" href="#Weverything"><code class="Fl">-Weverything</code></a></dt>
758+
<dd>Enables literally every warning.</dd>
759+
</dl>
760+
<p class="Pp">The following warnings are actual warning flags; with each
761+
description, the corresponding warning flag is included. Note that each of
762+
these flag also has a negation (for example,
763+
<code class="Fl">-Wtrim-nonempty</code> enables the warning that
764+
<code class="Fl">-Wno-trim-nonempty</code> disables; and
765+
<code class="Fl">-Wall</code> enables every warning that
766+
<code class="Fl">-Wno-all</code> disables). Only the non-default flag is
767+
listed here. Ignoring the &#x201C;no-&#x201D; prefix, entries are listed
768+
alphabetically.</p>
769+
<dl class="Bl-tag">
770+
<dt id="Wembedded"><a class="permalink" href="#Wembedded"><code class="Fl">-Wembedded</code></a></dt>
771+
<dd>Warn when a generated palette is sorted according to the input PNG's
772+
embedded palette but <code class="Fl">-c</code>
773+
<code class="Cm">embedded</code> was not provided. This warning is enabled
774+
by <code class="Fl">-Weverything</code>.</dd>
775+
<dt id="Wtrim-nonempty"><a class="permalink" href="#Wtrim-nonempty"><code class="Fl">-Wtrim-nonempty</code></a></dt>
776+
<dd>Warn when <code class="Fl">-x</code> trims a nonempty tile. An
777+
&quot;empty&quot; tile uses entirely color 0 of its palette. This warning
778+
is enabled by <code class="Fl">-Wall</code>.</dd>
779+
</dl>
780+
</section>
781+
<section class="Sh">
721782
<h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
722783
<p class="Pp">The following will only validate the
723784
&#x2018;<code class="Li">tileset.png</code>&#x2019; image (check its size,

docs/rgbgfx.1.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ export const toc = [
7070
"id": "REVERSE_MODE",
7171
"level": 2,
7272
},
73+
{
74+
"value": "DIAGNOSTICS",
75+
"id": "DIAGNOSTICS",
76+
"level": 2,
77+
},
7378
{
7479
"value": "EXAMPLES",
7580
"id": "EXAMPLES",

docs/rgbgfx.1.pdf

2.88 KB
Binary file not shown.

0 commit comments

Comments
 (0)