Rooba
/
ReC98
mirror of https://github.com/nmlgc/ReC98.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Contributing] BSS padding bytes should be rewritten into `evendata`

This commit is contained in:
nmlgc 2020-01-16 20:26:17 +01:00
parent 98e07ec5e1
commit 3a2b26c370
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -55,10 +55,14 @@ binary, as compared using [mzdiff].** The only allowed exceptions are:
(Counterexample: Small, insignificant amounts of pixels in e.g. entity
movement code.)
* Try rewriting `db 0` or `NOP` padding instructions in ASM land into `even`
or `align 2` directives. This makes mzdiffs a bit shorter in common cases
where a single byte was erroneously added somewhere, by providing a chance
for the code to catch up to its original byte positions.
* Try rewriting padding instructions in ASM land into TASM directives:
* `db 0` / `NOP` → `even` / `align 2`
* `db ?` → `evendata`
This makes mzdiffs a bit shorter in common cases where a single byte was
erroneously added somewhere, by providing a chance for the code to catch up
to its original byte positions.
* Documenting function comments exclusively go into C/C++ header files, right
above the corresponding function prototype, *not* into ASM slices.