Skip to content

Commit d957a2f

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent 6f2ebe1 commit d957a2f

11 files changed

Lines changed: 17 additions & 16 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: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a><
99
[<code class="Fl"><a href="#g">-g</a></code> <var class="Ar">chars</var>]
1010
[<code class="Fl"><a href="#I">-I</a></code> <var class="Ar">path</var>]
1111
[<code class="Fl"><a href="#M">-M</a></code> <var class="Ar">depend_file</var>]
12-
[<code class="Fl"><a href="#M">-M</a><a href="#C">C</a></code>] [<code class="Fl"><a href="#M">-M</a><a href="#G">G</a></code>]
12+
[<code class="Fl"><a href="#M">-M</a><a href="#G">G</a></code>] [<code class="Fl"><a href="#M">-M</a><a href="#C">C</a></code>]
1313
[<code class="Fl"><a href="#M">-M</a><a href="#P">P</a></code>] [<code class="Fl"><a href="#M">-M</a><a href="#T">T</a></code>
1414
<var class="Ar">target_file</var>] [<code class="Fl"><a href="#M">-M</a><a href="#Q">Q</a></code>
1515
<var class="Ar">target_file</var>] [<code class="Fl"><a href="#o">-o</a></code>
@@ -75,11 +75,11 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
7575
<var class="Ar">path</var>, <code class="Fl">--include</code>
7676
<var class="Ar">path</var></dt>
7777
<dd>Add a new &#x201C;include path&#x201D;; <var class="Ar">path</var> must
78-
point to a directory. When a <code class="Ic">INCLUDE</code> (including
79-
the implicit one from <code class="Fl">-P</code>) or
80-
<code class="Ic">INCBIN</code> is attempted,
81-
<code class="Nm">rgbasm</code> first looks up the provided path from its
82-
working directory; if this fails, it tries again from each of the
78+
point to a directory. When any <code class="Ic">INCLUDE</code> (including
79+
the implicit one from <code class="Fl">-P</code>),
80+
<code class="Ic">INCBIN</code>, or <code class="Ic">READFILE</code> is
81+
attempted, <code class="Nm">rgbasm</code> first looks up the provided path
82+
from its working directory; if this fails, it tries again from each of the
8383
&#x201C;include path&#x201D; directories, in the order they were
8484
provided.</dd>
8585
<dt id="M"><a class="permalink" href="#M"><code class="Fl">-M</code></a>
@@ -88,6 +88,17 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
8888
<dd>Write
8989
<a class="Xr" href="https://man7.org/linux/man-pages/man1/make.1.html">make(1)</a>
9090
dependencies to <var class="Ar">depend_file</var>.</dd>
91+
<dt id="MG"><a class="permalink" href="#MG"><code class="Fl">-MG</code></a></dt>
92+
<dd>To be used in conjunction with <code class="Fl">-M</code>. This makes
93+
<code class="Nm">rgbasm</code> assume that missing files are
94+
auto-generated: when any <code class="Ic">INCLUDE</code> (including the
95+
implicit one from <code class="Fl">-P</code>),
96+
<code class="Ic">INCBIN</code>, or <code class="Ic">READFILE</code> is
97+
attempted on a non-existent file, it is added as a dependency, then
98+
<code class="Nm">rgbasm</code> exits normally or continues processing
99+
(depending on whether <code class="Fl">-MC</code> was enabled) instead of
100+
erroring out. This feature is used in automatic updating of
101+
Makefiles.</dd>
91102
<dt id="MC"><a class="permalink" href="#MC"><code class="Fl">-MC</code></a></dt>
92103
<dd>Implies <code class="Fl">-MG</code>. This makes
93104
<code class="Nm">rgbasm</code> continue processing after a non-existent
@@ -96,16 +107,6 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
96107
recommended if any non-existent dependencies would have influenced
97108
subsequent processing, e.g. by causing an <code class="Ic">IF</code>
98109
condition to take a different branch.</dd>
99-
<dt id="MG"><a class="permalink" href="#MG"><code class="Fl">-MG</code></a></dt>
100-
<dd>To be used in conjunction with <code class="Fl">-M</code>. This makes
101-
<code class="Nm">rgbasm</code> assume that missing files are
102-
auto-generated: when <code class="Ic">INCLUDE</code> (including the
103-
implicit one from <code class="Fl">-P</code>) or
104-
<code class="Ic">INCBIN</code> is attempted on a non-existent file, it is
105-
added as a dependency, then <code class="Nm">rgbasm</code> exits normally
106-
or continues processing (depending on whether <code class="Fl">-MC</code>
107-
was enabled) instead of erroring out. This feature is used in automatic
108-
updating of Makefiles.</dd>
109110
<dt id="MP"><a class="permalink" href="#MP"><code class="Fl">-MP</code></a></dt>
110111
<dd>When enabled, this adds a phony target to the rules emitted by
111112
<code class="Fl">-M</code> for each dependency other than the main file.

docs/rgbasm.1.pdf

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

0 Bytes
Binary file not shown.

docs/rgblink.1.pdf

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)