diff options
| author | Derek Hensley <hensley.derek58@gmail.com> | 2024-06-01 08:01:19 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-01 11:01:19 -0400 |
| commit | 312b65d5e34878df4b70d8b9922e1082213b3662 (patch) | |
| tree | 15e17c2624fb353b82bbf593ce429a430d613324 /docs | |
| parent | 659e2b5088eb960594844d2dd3625779c11476ca (diff) | |
Even more general cleanup (#1640)
* floats
* obj_lightblock externs
* Couple more floats
* slime floats
* undefined_syms
* Move some tools to the tools folder
* format
* Update src/overlays/actors/ovl_Bg_Dblue_Waterfall/z_bg_dblue_waterfall.c
Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>
---------
Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | docs/tools.md | 18 |
2 files changed, 10 insertions, 10 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index f5a042846..44ee15e90 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -110,7 +110,7 @@ See the [Style Guide](STYLE.md) for more details on documentation style. Before opening a PR, walk through the following steps to ensure that your code conforms to the style guide and conventions. - `make` successfully builds a matching ROM. -- `./format.py` was run to apply standard formatting. +- `./tools/format.py` was run to apply standard formatting. - No new compiler warnings were introduced during the build process. - Can be verified locally by running `tools/warnings_count/check_new_warnings.sh` - New variables & functions should follow standard naming conventions. diff --git a/docs/tools.md b/docs/tools.md index 9ec495313..8df39fde5 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -6,8 +6,8 @@ - [`diff.py`](#diffpy) - [`tools/m2ctx.py`](#toolsm2ctxpy) - [`tools/overlayhelpers/actor_symbols.py`](#toolsoverlayhelpersactor_symbolspy) - - [`first_diff.py`](#first_diffpy) - - [`sym_info.py`](#sym_infopy) + - [`tools/first_diff.py`](#first_diffpy) + - [`tools/sym_info.py`](#sym_infopy) - [`extract_assets.py`](#extract_assetspy) - [`tools/assist.py`](#toolsassistpy) - [`tools/get_actor_sizes.py`](#toolsget_actor_sizespy) @@ -22,8 +22,8 @@ - [`tools/graphovl.py`](#toolsgraphovlpy) - [`tools/warnings_count/check_new_warnings.sh`](#toolswarnings_countcheck_new_warningssh) - [`tools/warnings_count/update_current_warnings.sh`](#toolswarnings_countupdate_current_warningssh) - - [`fixle.sh`](#fixlesh) - - [`format.py`](#formatpy) + - [`tools/fixle.sh`](#fixlesh) + - [`tools/format.py`](#formatpy) - [External tools](#external-tools) - [mips_to_c](#mips_to_c) - [Permuter](#permuter) @@ -108,16 +108,16 @@ Pass it the path to a C file to generate the context for that C file, to help [m Takes a VRAM or VROM address to get overlay file and offset for an Actor. -### `first_diff.py` +### `tools/first_diff.py` Gives you the addresses of first difference in the ROM, the difference, and a count of how many bytes differ, or if the whole ROM is shifted. -### `sym_info.py` +### `tools/sym_info.py` Can be given a symbol (function or variable name, for example), and will find its ROM, VRAM, and file using the map file. E.g. ```bash -$ ./sym_info.py ObjTree_Init +$ ./tools/sym_info.py ObjTree_Init Symbol ObjTree_Init (RAM: 0x80B9A0B0, ROM: 0xFFF210, build/n64-us/src/overlays/actors/ovl_Obj_Tree/z_obj_tree.o) ``` @@ -208,11 +208,11 @@ Run `check_new_warnings.sh -h` for more information. If you have to add new warnings, **and have permission from the leads**, run this to update the file used for warnings comparison. -### `fixle.sh` +### `tools/fixle.sh` Fixes line endings in the repo to Linux style (LF), which is required for the build process to work. (You may be better off creating a new clone directly in Linux/WSL, though) -### `format.py` +### `tools/format.py` Formats all C files in the repo using `clang-format-14`, `clang-tidy`, and `clang-apply-replacements` (when multiprocessing). This will touch all files in the repo, so the next `make` will take longer. |