Cleanup Function

Instructions

Look at the function. Think about what its purpose is in the broader project and how it relates to other functions (as a caller / callee).

Update the function to preserve the 100% match while better reflecting what the original developers would've written.

Once you have fixed the header issue, run the following command to verify you haven't broken the build:

./tools/build-and-verify.sh

Commit your changes when you're done.

Unable to clean up the function

If you're unable to clean up the function without breaking the build, revert all of your changes to ensure the build remains clean then exit.

Safe Refactoring

Identify Structs and Arrays

There are many kinds of refactoring that is safe to perform without breaking the match.

The most common example is swapping pointer arithmatic for proper struct / array types. For example:

*(s16 *)((u8 *)arg0 + 0x28) -= 1;

Could easily be rewritten as:

arg0->unk28 -= 1

We just need to provide a suitable type definition for arg0.

Similarly:

temp_a0 = (s8 *)(offset + (s32)arg0->entries)

Could be re-written as an array access:

temp_a0 = arg0->entries[i]

(Note that in the above example offset is computed as essentially 0x10*i indicating size 0x10 structs as the array items.)

Local variable names

Local variables within a function can be safely renamed without affecting the match. This can be a great way to communicate the intent behind a function.