From 6cce7fbde61fe5cd9c1e54003a40878c05b2893b Mon Sep 17 00:00:00 2001 From: Rangi42 Date: Sat, 18 Jan 2025 13:26:02 -0500 Subject: [PATCH] Create a BUGS section --- man/rgbasm-old.5 | 107 ++++++++++++++++++++++++++++------------------- 1 file changed, 63 insertions(+), 44 deletions(-) diff --git a/man/rgbasm-old.5 b/man/rgbasm-old.5 index 5f0fd83c6..f307a0f27 100644 --- a/man/rgbasm-old.5 +++ b/man/rgbasm-old.5 @@ -15,7 +15,7 @@ assembly language over its decades of evolution, along with their modern alterna Its goal is to be a reference for backwards incompatibility, when upgrading an old assembly codebase to work with the latest RGBDS release. It does .Em not -attempt to list syntax bugs that were fixed, nor new reserved keywords that may conflict with old identifiers. +attempt to list every syntax bug that was ever fixed (with some notable exceptions), nor new reserved keywords that may conflict with old identifiers. .Sh REMOVED These are features which have been completely removed, without any direct alternatives. Usually these features were limiting the addition of other features, or had awkward limits on their own intended effects. @@ -176,33 +176,6 @@ Instead, use explicit colons; for example, .Ql Label: or exported .Ql Label:: . -.Ss Space between exported labels' colons -Removed in 0.7.0. -.Pp -Labels with two colons used to allow a space between them; for example, -.Ql Label:\ : . -.Pp -Instead, use -.Ql Label:: . -.Ss Space between label and colon -Removed in 0.9.0. -.Pp -Space between a label and its colon(s) used to be allowed; for example, -.Ql Label\ : -and -.Ql Label\ :: . -Now they are treated as invocations of the -.Ql Label -macro with -.Ql \&: -and -.Ql :: -as arguments. -.Pp -Instead, use -.Ql Label: -and -.Ql Label:: . .Ss '\e,' in strings within macro arguments Deprecated in 0.5.0, removed in 0.7.0. .Pp @@ -320,22 +293,6 @@ Supported in ASMotor, removed in RGBDS. .Pp Instead, use .Ql LD HL, SP + e8 . -.Ss ADD r16 with implicit first HL operand -Removed in 0.5.0. -.Pp -For example, -.Ql ADD BC -used to be treated as -.Ql ADD HL, BC , -and likewise for -.Ql DE , -.Ql HL , -and -.Ql SP . -.Pp -Instead, use an explicit first -.Ql HL -operand. .Ss rgbasm -i Deprecated in 0.6.0, removed in 0.8.0. .Pp @@ -403,6 +360,68 @@ Previously we had .Pp Instead, now we have .Ql p ** q ** r == p ** (q ** r) . +.Sh BUGS +These are misfeatures that may have been possible by mistake. +They do not get deprecated, just fixed. +.Ss Space between exported labels' colons +Fixed in 0.7.0. +.Pp +Labels with two colons used to ignore a space between them; for example, +.Ql Label:\ : . +.Pp +Instead, use +.Ql Label:: . +.Ss Space between label and colon +Fixed in 0.9.0. +.Pp +Space between a label and its colon(s) used to be ignored; for example, +.Ql Label\ : +and +.Ql Label\ :: . +Now they are treated as invocations of the +.Ql Label +macro with +.Ql \&: +and +.Ql :: +as arguments. +.Pp +Instead, use +.Ql Label: +and +.Ql Label:: . +.Ss ADD r16 with implicit first HL operand +Fixed in 0.5.0. +.Pp +For example, +.Ql ADD BC +used to be treated as +.Ql ADD HL, BC , +and likewise for +.Ql DE , +.Ql HL , +and +.Ql SP . +.Pp +Instead, use an explicit first +.Ql HL +operand. +.Ss = instead of SET +Fixed in 0.4.0. +.Pp +The +.Ic = +operator used to be an alias for the +.Ic SET +keyword, which included using +.Ic = +for the +.Ic SET +.Em instruction . +.Pp +Instead, just use +.Ic SET +for the instruction. .Sh SEE ALSO .Xr rgbasm 1 , .Xr gbz80 7 ,