gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-20 10:12:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rephrase PURGE documentation and raise the default level to 2

Browse Source 
Fixes #1847
This commit is contained in:
Rangi42
2025-10-13 11:43:29 -04:00
parent 651877e094
commit aa672bbec9
3 changed files with 16 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
man/rgbasm.5
View File

@@ -1711,15 +1711,21 @@ Note also that only exported symbols will appear in symbol and map files produce
.Ss Purging symbols
.Ic PURGE
allows you to completely remove a symbol from the symbol table, as if it had never been defined.
.Bd -literal -offset indent
DEF value EQU 42
PURGE value
DEF value EQUS "I'm a string now"
ASSERT DEF(value)
PURGE value
ASSERT !DEF(value)
.Ed
.Pp
Be
.Em very
careful when purging symbols, especially labels, because it could result in unpredictable errors if something depends on the missing symbol (for example, expressions the linker needs to calculate).
.Bd -literal -offset indent
DEF Kamikaze EQUS "I don't want to live anymore"
AOLer: DB "Me too lol"
PURGE Kamikaze, AOLer
ASSERT !DEF(Kamikaze) && !DEF(AOLer)
.Ed
careful when purging symbols that have been referenced in section data, or that have been exported, because it could result in unpredictable errors if something depends on the missing symbol (for example, expressions the linker needs to calculate).
Purging labels at all is
.Em not
recommended.
.Pp
String constants are not expanded within the symbol names.
.Ss Predeclared symbols