summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLéo Lam <leo@leolam.fr>2022-06-21 22:43:07 +0200
committerLéo Lam <leo@leolam.fr>2022-06-21 22:43:23 +0200
commit9f25b2ec73491c9e661f2be1fe424c46d2ed7591 (patch)
treef92eb8e04de7d32b8f2253abf0c51be8c8e59b36
parent36cd120d262a284c0f4a41f2a21488912fb346ba (diff)
Contributing: Mention how to import types into the IDB
-rw-r--r--Contributing.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/Contributing.md b/Contributing.md
index 39b9377e..14177e6a 100644
--- a/Contributing.md
+++ b/Contributing.md
@@ -166,10 +166,12 @@ Note that you will need to import names and types manually and you will not be a
* If your Linux distro or system (e.g. macOS) does not package clang-format 12, you can download it from [the LLVM project website here](https://releases.llvm.org/download.html)
-## Importing names from the decomp source code
+## Importing names or types from source code
In IDA, run the `tools/common/rename_functions_in_ida.py` script (File > Script file...) to import names from the decomp source code back into the IDA database. This can be done as often as you want.
+To import types into the IDB, you can use [classgen](https://github.com/leoetlino/classgen) ([binary builds available here](https://github.com/leoetlino/classgen/releases/latest)) or IDA Pro 7.7's Clang-based header parser (less convenient).
+
## Code style
BotW has 40MB of code and contributors *need* to read and modify existing parts of the codebase very often: inconsistencies lead to a loss of efficiency, and we literally cannot afford that considering our small number of contributors. To avoid wasting time on formatting issues, we use clang-format to automatically enforce a consistent coding style.