mmtk / mmtk-core

Memory Management ToolKit
https://www.mmtk.io
Other
379 stars 69 forks source link

Dead Links in documentation #1084

Closed Pat-Lafon closed 9 months ago

Pat-Lafon commented 9 months ago

Hello!

I apologize for not using a template but this issue seems unrelated to the templates provided. For fun, I was attempting to follow the NoGC porting guide for a toy language however I had trouble following the guide because some of the links were dead. It seems some parts of the repository at least relating to the dummy vm have been moved.

Concretely, atleast two links in https://docs.mmtk.io/portingguide/howto/nogc.html pointing to the dummy vm like "https://github.com/mmtk/mmtk-core/tree/master/vmbindings/dummyvm".

It might be worth setting up a dead link checker as part of your github actions but that is up to the maintainers' interest.

qinsoon commented 9 months ago

Hi @Pat-Lafon. Thanks for reporting the issue. I have opened a PR to add a broken link checker to the CI and fixed the broken links related to DummyVM.

As DummyVM was removed, there is no equivalent in mmtk-core at the moment. So we no longer provide any code that you can directly copy from to start a new MMTk binding project. I recommend taking a look at one of our bindings: for example, the OpenJDK binding. For the header file in the old dummy vm, you can find it here.

Thanks again for submitting the issue. Please feel free to ask if you encounter any further problem.