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]>

.gitignore

@@ -1,5 +1,7 @@
 # Dependencies
 /node_modules
+.yarn
+.yarnrc.yml
 
 # Production
 /build

docs/index.md

@@ -31,6 +31,7 @@ PDFs are also offered for offline reading, and maybe printing.
 - **Language reference**: documentation of the various languages used throughout RGBDS.
   - [Assembly syntax](./rgbasm.5.md): how to write RGBASM-flavored Game Boy assembly, and what the various directives do. ([PDF](./rgbasm.5.pdf))
   - [CPU instructions](./gbz80.7.md): a list of CPU instructions, as well as quick descriptions of their various effects.  ([PDF](./gbz80.7.pdf))
+  - [Obsolete syntax](./rgbasm-old.5.md): instructions and directives removed from previous versions of RGBDS. ([PDF](./rgbasm-old.5.pdf))
   - [Linkerscript format](./rgblink.5.md): how to write a linker script for RGBLINK. [PDF](./rgblink.5.pdf))
   - [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))
 - **Command-line options**: how to write the command lines to invoke RGBDS programs.

docs/rgbasm-old.5.md

@@ -0,0 +1,178 @@
+# rgbasm-old(5) — obsolete language documentation
+
+import generated from '!!raw-loader!./rgbasm-old.5.html';
+
+<div className="manual-text" dangerouslySetInnerHTML={{ __html: generated }} />
+
+export const toc = [
+{
+	"value": "DESCRIPTION",
+	"id": "DESCRIPTION",
+	"level": 2,
+},
+{
+	"value": "REMOVED",
+	"id": "REMOVED",
+	"level": 2,
+},
+{
+	"value": "Automatic LD to LDH conversion (rgbasm -l)",
+	"id": "Automatic_LD_to_LDH_conversion_(rgbasm_-l)",
+	"level": 3,
+},
+{
+	"value": "Automatic NOP after HALT (rgbasm -H)",
+	"id": "Automatic_NOP_after_HALT_(rgbasm_-H)",
+	"level": 3,
+},
+{
+	"value": "Nested macro definitions",
+	"id": "Nested_macro_definitions",
+	"level": 3,
+},
+{
+	"value": "Negative DS",
+	"id": "Negative_DS",
+	"level": 3,
+},
+{
+	"value": "__FILE__ and __LINE__",
+	"id": "__FILE___and___LINE__",
+	"level": 3,
+},
+{
+	"value": "_PI",
+	"id": "_PI",
+	"level": 3,
+},
+{
+	"value": "Treating multi-character strings as numbers",
+	"id": "Treating_multi-character_strings_as_numbers",
+	"level": 3,
+},
+{
+	"value": "rgbgfx -f/--fix and -F/--fix-and-save",
+	"id": "rgbgfx_-f/--fix_and_-F/--fix-and-save",
+	"level": 3,
+},
+{
+	"value": "rgbgfx -D/--debug",
+	"id": "rgbgfx_-D/--debug",
+	"level": 3,
+},
+{
+	"value": "REPLACED",
+	"id": "REPLACED",
+	"level": 2,
+},
+{
+	"value": "Defining constants and variables without DEF",
+	"id": "Defining_constants_and_variables_without_DEF",
+	"level": 3,
+},
+{
+	"value": "Defining macros like labels",
+	"id": "Defining_macros_like_labels",
+	"level": 3,
+},
+{
+	"value": "Defining variables with SET",
+	"id": "Defining_variables_with_SET",
+	"level": 3,
+},
+{
+	"value": "Global labels without colons",
+	"id": "Global_labels_without_colons",
+	"level": 3,
+},
+{
+	"value": "'\e,' in strings within macro arguments",
+	"id": "'_e,'_in_strings_within_macro_arguments",
+	"level": 3,
+},
+{
+	"value": "'*' comments",
+	"id": "'*'_comments",
+	"level": 3,
+},
+{
+	"value": "PRINTT, PRINTI, PRINTV, and PRINTF",
+	"id": "PRINTT,_PRINTI,_PRINTV,_and_PRINTF",
+	"level": 3,
+},
+{
+	"value": "IMPORT and XREF",
+	"id": "IMPORT_and_XREF",
+	"level": 3,
+},
+{
+	"value": "GLOBAL and XDEF",
+	"id": "GLOBAL_and_XDEF",
+	"level": 3,
+},
+{
+	"value": "HOME, CODE, DATA, and BSS",
+	"id": "HOME,_CODE,_DATA,_and_BSS",
+	"level": 3,
+},
+{
+	"value": "JP [HL]",
+	"id": "JP__HL_",
+	"level": 3,
+},
+{
+	"value": "LDI A, HL and LDD A, HL",
+	"id": "LDI_A,_HL_and_LDD_A,_HL",
+	"level": 3,
+},
+{
+	"value": "LD HL, [SP + e8]",
+	"id": "LD_HL,__SP_+_e8_",
+	"level": 3,
+},
+{
+	"value": "LDIO",
+	"id": "LDIO",
+	"level": 3,
+},
+{
+	"value": "rgbasm -i",
+	"id": "rgbasm_-i",
+	"level": 3,
+},
+{
+	"value": "rgbgfx -h",
+	"id": "rgbgfx_-h",
+	"level": 3,
+},
+{
+	"value": "rgbgfx --output-*",
+	"id": "rgbgfx_--output-*",
+	"level": 3,
+},
+{
+	"value": "CHANGED",
+	"id": "CHANGED",
+	"level": 2,
+},
+{
+	"value": "Trigonometry function units",
+	"id": "Trigonometry_function_units",
+	"level": 3,
+},
+{
+	"value": "** operator associativity",
+	"id": "**_operator_associativity",
+	"level": 3,
+},
+{
+	"value": "SEE ALSO",
+	"id": "SEE_ALSO",
+	"level": 2,
+},
+{
+	"value": "HISTORY",
+	"id": "HISTORY",
+	"level": 2,
+},
+];

maintainer/support/index.md

@@ -13,6 +13,7 @@ PDFs are also offered for offline reading, and maybe printing.
 - **Language reference**: documentation of the various languages used throughout RGBDS.
   - [Assembly syntax](./rgbasm.5.md): how to write RGBASM-flavored Game Boy assembly, and what the various directives do. ([PDF](./rgbasm.5.pdf))
   - [CPU instructions](./gbz80.7.md): a list of CPU instructions, as well as quick descriptions of their various effects. ([PDF](./gbz80.7.pdf))
+  - [Obsolete syntax](./rgbasm-old.5.md): instructions and directives removed from previous versions of RGBDS. ([PDF](./rgbasm-old.5.pdf))
   - [Linkerscript format](./rgblink.5.md): how to write a linker script for RGBLINK. ([PDF](./rgblink.5.pdf))
   - [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))
 - **Command-line options**: how to write the command lines to invoke RGBDS programs.

sidebars.js

@@ -8,6 +8,7 @@ const sidebars = {
       "Language reference": [
         { type: 'doc', id: 'rgbasm.5', label: "Assembly syntax" },
         { type: 'doc', id: 'gbz80.7', label: "CPU instructions" },
+        { type: 'doc', id: 'rgbasm-old.5', label: "Obsolete syntax" },
         { type: 'doc', id: 'rgblink.5', label: "Linkerscript format" },
         { type: 'doc', id: 'rgbds.5', label: "Object file format" },
       ]