Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken links in the tutorial #936

Merged
merged 3 commits into from
Sep 4, 2023
Merged

Fix broken links in the tutorial #936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7ab863
Update collection.md
caizixian Sep 4, 2023
8946863
Update what_will_this_tutorial_cover.md
caizixian Sep 4, 2023
1fc649e
Update exercise_solution.md
caizixian Sep 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/userguide/src/tutorial/intro/what_will_this_tutorial_cover.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ finished code provided.
Furthermore, please note that this code may not be identical to the main code
of the MMTk. It is deliberately kept separate as a simpler stable
version. Make sure to refer to the
[provided tutorial code](https://github.com/mmtk/mmtk-core/tree/master/docs/tutorial/code)
and not the main collector code during the tutorial.
[provided tutorial code](https://github.com/mmtk/mmtk-core/tree/master/docs/userguide/src/tutorial/code)
and not the main collector code during the tutorial.
6 changes: 3 additions & 3 deletions docs/userguide/src/tutorial/mygc/ss/collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ are.
### Approach 1: Use `SFTProcessEdges`

[`SFTProcessEdges`](https://docs.mmtk.io/api/mmtk/scheduler/gc_work/struct.SFTProcessEdges.html) dispatches
the tracing of objects to their respective spaces through [Space Function Table (SFT)](https://docs.mmtk.io/api/mmtk/policy/space/trait.SFT.html).
the tracing of objects to their respective spaces through [Space Function Table (SFT)](https://docs.mmtk.io/api/mmtk/policy/sft/trait.SFT.html).
As long as all the policies in a plan provide an implementation of `sft_trace_object()` in their SFT implementations,
the plan can use `SFTProcessEdges`. Currently most policies provide an implementation for `sft_trace_object()`, except
mark compact and immix. Those two policies use multiple GC traces, and due to the limitation of SFT, SFT does not allow
Expand All @@ -176,7 +176,7 @@ multiple `sft_trace_object()` for a policy.
### Approach 2: Derive `PlanTraceObject` and use `PlanProcessEdges`

`PlanProcessEdges` is another general `ProcessEdgesWork` implementation that can be used by most plans. When a plan
implements the [`PlanTraceObject`](https://docs.mmtk.io/api/mmtk/plan/transitive_closure/trait.PlanTraceObject.html),
implements the [`PlanTraceObject`](https://docs.mmtk.io/api/mmtk/plan/global/trait.PlanTraceObject.html),
it can use `PlanProcessEdges`.

You can manually provide an implementation of `PlanTraceObject` for `MyGC`. But you can also use the derive macro MMTK provides,
Expand Down Expand Up @@ -244,4 +244,4 @@ If the benchmarks pass - good job! You have built a functional copying
collector!

If you get particularly stuck, the code for the completed `MyGC` plan
is available [here](https://github.com/mmtk/mmtk-core/tree/master/docs/tutorial/code/mygc_semispace).
is available [here](https://github.com/mmtk/mmtk-core/tree/master/docs/userguide/src/tutorial/code/mygc_semispace).
2 changes: 1 addition & 1 deletion docs/userguide/src/tutorial/mygc/ss/exercise_solution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ in case you are stuck on the exercise.
**Attempt the exercise yourself before reading this.**

First, rename all instances of `mygc` to `triplespace`, and add it as a
module by following the instructions in [Create MyGC](./create.md).
module by following the instructions in [Create MyGC](../create.md).

In `triplespace/global.rs`:

Expand Down
Loading