Skip to content

Port docs from PH - #90

Merged
Yanis002 merged 24 commits into
zeldaret:mainfrom
Mityno:port-docs
Aug 8, 2026
Merged

Port docs from PH#90
Yanis002 merged 24 commits into
zeldaret:mainfrom
Mityno:port-docs

Conversation

@Mityno

@Mityno Mityno commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@decomp-dev

decomp-dev Bot commented Jun 19, 2026

Copy link
Copy Markdown

Report for eur (9ada2de - f49eafa)

No changes

Report for jp (9ada2de - f49eafa)

No changes

@Yanis002 Yanis002 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I started the review thinking it was ready and just as I'm about to be done I notice the draft lol (no worries it's a me issue), anyway here's my comments for now, feel free if you have any questions

Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md
Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md Outdated
1. Press the `decomp.me` button in `objdiff`.
1. Once you're sent to `decomp.me`, go to "Options" and change the preset to "Phantom Hourglass".
1. Paste your code into the "Source code" tab.
1. Share the link with us!

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Share the link with us!
1. Share the link with us!
Note: if the function is using THUMB mode you can use `THUMB_BEGIN` and `THUMB_END` before and after the function to create a THUMB region, anything outside of the region will use ARM.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh yeah also, as I learned yesterday, if you have inlines in a header and #include the header outside of the region it will use ARM, but if you do include it inside the thumb region it will use thumb

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh yeah also, as I learned yesterday, if you have inlines in a header and #include the header outside of the region it will use ARM, but if you do include it inside the thumb region it will use thumb

I tried to include that in the description if that's what you wanted, let me know how it works for you

Comment thread docs/decompiling.md

Another consequence of having a destructor is that a `DestructorChain` object will be added to the `.bss` section. This struct
is 12 (`0xc`) bytes long and is also implicit, so we don't need to define it ourselves.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to this I'd like to add that if you have multiple ctors in the same file they will all end up in the same static initializer function, meaning the order of the declarations will change the order of the code from the sinit function (also something else to know is that you only have one sinit per source file)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm unsure how to formulate that since I don't fully understand what is going on, I'll leave that small comment to you if you have time

Comment thread docs/decompiling.md Outdated
@Mityno
Mityno marked this pull request as ready for review August 3, 2026 12:15
@Mityno

Mityno commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

I'm putting this as ready mainly because I think it needs a review, maybe the merge can be delayed even once reviewed if there is more to do.
My goal was to add docs so that people can setup the project (most of that already existed) and start decompiling in the environment easily, which I feel like is done.
The tips.md will probably grow with time, and it feels a little bit like the usual "utils" directory where everything is put before being moved to some more appropriate place later. We might want to give it a different structure, I dunno.

Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md
Comment thread docs/decompiling.md Outdated
Comment thread docs/decompiling.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
Comment thread INSTALL.md
@Yanis002
Yanis002 merged commit a05f3d3 into zeldaret:main Aug 8, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants