Skip to content

Commit 5735349

Browse files
authored
Fix broken links in the tutorial (#936)
1 parent aedb37a commit 5735349

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/userguide/src/tutorial/intro/what_will_this_tutorial_cover.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ finished code provided.
2020
Furthermore, please note that this code may not be identical to the main code
2121
of the MMTk. It is deliberately kept separate as a simpler stable
2222
version. Make sure to refer to the
23-
[provided tutorial code](https://github.com/mmtk/mmtk-core/tree/master/docs/tutorial/code)
24-
and not the main collector code during the tutorial.
23+
[provided tutorial code](https://github.com/mmtk/mmtk-core/tree/master/docs/userguide/src/tutorial/code)
24+
and not the main collector code during the tutorial.

docs/userguide/src/tutorial/mygc/ss/collection.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ are.
165165
### Approach 1: Use `SFTProcessEdges`
166166

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

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

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

246246
If you get particularly stuck, the code for the completed `MyGC` plan
247-
is available [here](https://github.com/mmtk/mmtk-core/tree/master/docs/tutorial/code/mygc_semispace).
247+
is available [here](https://github.com/mmtk/mmtk-core/tree/master/docs/userguide/src/tutorial/code/mygc_semispace).

docs/userguide/src/tutorial/mygc/ss/exercise_solution.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ in case you are stuck on the exercise.
66
**Attempt the exercise yourself before reading this.**
77

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

1111
In `triplespace/global.rs`:
1212

0 commit comments

Comments
 (0)