Skip to content

Commit 7438442

Browse files
Rangi42avivace
Rangi42
and
avivace
authored
Add rgbasm-old.5 as an "Obsolete syntax" page (#71)
* Add rgbasm-old.5 as an "Obsolete syntax" page * Generate rgbasm-old docs * Update docs based on current PR * Remove redirect until 0.9.0 is the "latestStable" version Co-authored-by: Antonio Vivace <[email protected]>
1 parent 5bc8908 commit 7438442

File tree

7 files changed

+559
-0
lines changed

7 files changed

+559
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Dependencies
22
/node_modules
3+
.yarn
4+
.yarnrc.yml
35

46
# Production
57
/build

‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ PDFs are also offered for offline reading, and maybe printing.
3131
- **Language reference**: documentation of the various languages used throughout RGBDS.
3232
- [Assembly syntax](./rgbasm.5.md): how to write RGBASM-flavored Game Boy assembly, and what the various directives do. ([PDF](./rgbasm.5.pdf))
3333
- [CPU instructions](./gbz80.7.md): a list of CPU instructions, as well as quick descriptions of their various effects. ([PDF](./gbz80.7.pdf))
34+
- [Obsolete syntax](./rgbasm-old.5.md): instructions and directives removed from previous versions of RGBDS. ([PDF](./rgbasm-old.5.pdf))
3435
- [Linkerscript format](./rgblink.5.md): how to write a linker script for RGBLINK. [PDF](./rgblink.5.pdf))
3536
- [Object file format](./rgbds.5.md): a description of the format of files emitted by RGBASM and expected by RGBLINK; useful for integrating custom tooling with RGBDS. ([PDF](./rgbds.5.pdf))
3637
- **Command-line options**: how to write the command lines to invoke RGBDS programs.

‎docs/rgbasm-old.5.html

+376
Large diffs are not rendered by default.

‎docs/rgbasm-old.5.md

+178
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
# rgbasm-old(5) — obsolete language documentation
2+
3+
import generated from '!!raw-loader!./rgbasm-old.5.html';
4+
5+
<div className="manual-text" dangerouslySetInnerHTML={{ __html: generated }} />
6+
7+
export const toc = [
8+
{
9+
"value": "DESCRIPTION",
10+
"id": "DESCRIPTION",
11+
"level": 2,
12+
},
13+
{
14+
"value": "REMOVED",
15+
"id": "REMOVED",
16+
"level": 2,
17+
},
18+
{
19+
"value": "Automatic LD to LDH conversion (rgbasm -l)",
20+
"id": "Automatic_LD_to_LDH_conversion_(rgbasm_-l)",
21+
"level": 3,
22+
},
23+
{
24+
"value": "Automatic NOP after HALT (rgbasm -H)",
25+
"id": "Automatic_NOP_after_HALT_(rgbasm_-H)",
26+
"level": 3,
27+
},
28+
{
29+
"value": "Nested macro definitions",
30+
"id": "Nested_macro_definitions",
31+
"level": 3,
32+
},
33+
{
34+
"value": "Negative DS",
35+
"id": "Negative_DS",
36+
"level": 3,
37+
},
38+
{
39+
"value": "__FILE__ and __LINE__",
40+
"id": "__FILE___and___LINE__",
41+
"level": 3,
42+
},
43+
{
44+
"value": "_PI",
45+
"id": "_PI",
46+
"level": 3,
47+
},
48+
{
49+
"value": "Treating multi-character strings as numbers",
50+
"id": "Treating_multi-character_strings_as_numbers",
51+
"level": 3,
52+
},
53+
{
54+
"value": "rgbgfx -f/--fix and -F/--fix-and-save",
55+
"id": "rgbgfx_-f/--fix_and_-F/--fix-and-save",
56+
"level": 3,
57+
},
58+
{
59+
"value": "rgbgfx -D/--debug",
60+
"id": "rgbgfx_-D/--debug",
61+
"level": 3,
62+
},
63+
{
64+
"value": "REPLACED",
65+
"id": "REPLACED",
66+
"level": 2,
67+
},
68+
{
69+
"value": "Defining constants and variables without DEF",
70+
"id": "Defining_constants_and_variables_without_DEF",
71+
"level": 3,
72+
},
73+
{
74+
"value": "Defining macros like labels",
75+
"id": "Defining_macros_like_labels",
76+
"level": 3,
77+
},
78+
{
79+
"value": "Defining variables with SET",
80+
"id": "Defining_variables_with_SET",
81+
"level": 3,
82+
},
83+
{
84+
"value": "Global labels without colons",
85+
"id": "Global_labels_without_colons",
86+
"level": 3,
87+
},
88+
{
89+
"value": "'\e,' in strings within macro arguments",
90+
"id": "'_e,'_in_strings_within_macro_arguments",
91+
"level": 3,
92+
},
93+
{
94+
"value": "'*' comments",
95+
"id": "'*'_comments",
96+
"level": 3,
97+
},
98+
{
99+
"value": "PRINTT, PRINTI, PRINTV, and PRINTF",
100+
"id": "PRINTT,_PRINTI,_PRINTV,_and_PRINTF",
101+
"level": 3,
102+
},
103+
{
104+
"value": "IMPORT and XREF",
105+
"id": "IMPORT_and_XREF",
106+
"level": 3,
107+
},
108+
{
109+
"value": "GLOBAL and XDEF",
110+
"id": "GLOBAL_and_XDEF",
111+
"level": 3,
112+
},
113+
{
114+
"value": "HOME, CODE, DATA, and BSS",
115+
"id": "HOME,_CODE,_DATA,_and_BSS",
116+
"level": 3,
117+
},
118+
{
119+
"value": "JP [HL]",
120+
"id": "JP__HL_",
121+
"level": 3,
122+
},
123+
{
124+
"value": "LDI A, HL and LDD A, HL",
125+
"id": "LDI_A,_HL_and_LDD_A,_HL",
126+
"level": 3,
127+
},
128+
{
129+
"value": "LD HL, [SP + e8]",
130+
"id": "LD_HL,__SP_+_e8_",
131+
"level": 3,
132+
},
133+
{
134+
"value": "LDIO",
135+
"id": "LDIO",
136+
"level": 3,
137+
},
138+
{
139+
"value": "rgbasm -i",
140+
"id": "rgbasm_-i",
141+
"level": 3,
142+
},
143+
{
144+
"value": "rgbgfx -h",
145+
"id": "rgbgfx_-h",
146+
"level": 3,
147+
},
148+
{
149+
"value": "rgbgfx --output-*",
150+
"id": "rgbgfx_--output-*",
151+
"level": 3,
152+
},
153+
{
154+
"value": "CHANGED",
155+
"id": "CHANGED",
156+
"level": 2,
157+
},
158+
{
159+
"value": "Trigonometry function units",
160+
"id": "Trigonometry_function_units",
161+
"level": 3,
162+
},
163+
{
164+
"value": "** operator associativity",
165+
"id": "**_operator_associativity",
166+
"level": 3,
167+
},
168+
{
169+
"value": "SEE ALSO",
170+
"id": "SEE_ALSO",
171+
"level": 2,
172+
},
173+
{
174+
"value": "HISTORY",
175+
"id": "HISTORY",
176+
"level": 2,
177+
},
178+
];

‎docs/rgbasm-old.5.pdf

39.5 KB
Binary file not shown.

‎maintainer/support/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ PDFs are also offered for offline reading, and maybe printing.
1313
- **Language reference**: documentation of the various languages used throughout RGBDS.
1414
- [Assembly syntax](./rgbasm.5.md): how to write RGBASM-flavored Game Boy assembly, and what the various directives do. ([PDF](./rgbasm.5.pdf))
1515
- [CPU instructions](./gbz80.7.md): a list of CPU instructions, as well as quick descriptions of their various effects. ([PDF](./gbz80.7.pdf))
16+
- [Obsolete syntax](./rgbasm-old.5.md): instructions and directives removed from previous versions of RGBDS. ([PDF](./rgbasm-old.5.pdf))
1617
- [Linkerscript format](./rgblink.5.md): how to write a linker script for RGBLINK. ([PDF](./rgblink.5.pdf))
1718
- [Object file format](./rgbds.5.md): a description of the format of files emitted by RGBASM and expected by RGBLINK; useful for integrating custom tooling with RGBDS. ([PDF](./rgbds.5.pdf))
1819
- **Command-line options**: how to write the command lines to invoke RGBDS programs.

‎sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ const sidebars = {
88
"Language reference": [
99
{ type: 'doc', id: 'rgbasm.5', label: "Assembly syntax" },
1010
{ type: 'doc', id: 'gbz80.7', label: "CPU instructions" },
11+
{ type: 'doc', id: 'rgbasm-old.5', label: "Obsolete syntax" },
1112
{ type: 'doc', id: 'rgblink.5', label: "Linkerscript format" },
1213
{ type: 'doc', id: 'rgbds.5', label: "Object file format" },
1314
]

0 commit comments

Comments
 (0)