Skip to content

Commit 0abf707

Browse files
authored
Fix links (#4011)
1 parent 8181ef6 commit 0abf707

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

jane/doc/extensions/_02-unboxed-types/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Intro
66

77
The "unboxed types" extension provides users with additional control over the
88
way their data is represented in memory and registers. These new types have
9-
different *layouts*, which is part of their [kind](../kinds/intro), to
9+
different *layouts*, which is part of their [kind](../../kinds/intro), to
1010
distinguish them from normal OCaml types.
1111

1212
This page gives a comprehensive overview of the extension. Unboxed types are
@@ -109,7 +109,7 @@ let f5 x = (x : (_ : immediate))
109109
let f6: type (a: bits32). a -> a = fun x -> x
110110
```
111111

112-
The full syntax can be found in the [documentation for kinds](../kinds/syntax).
112+
The full syntax can be found in the [documentation for kinds](../../kinds/syntax).
113113
The complete annotation design is not yet implemented and the syntax should be
114114
read with `kind ::= layout-name` for now. It also provides reasoning around some
115115
design decisions and contains additional examples.

jane/doc/extensions/_03-parallelism/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Intro
88

99
OCaml 5 introduced multicore, which allows parallel execution in a single process.
1010
Based on that, the OCaml Language team developed a collection of compiler features and libraries:
11-
- Extending the [mode system](../modes/intro) to track values' concurrent
11+
- Extending the [mode system](../../modes/intro) to track values' concurrent
1212
usages, so they can be used concurrently safely.
1313
- Higher-level parallelism primitives to allow users to fully expose
1414
opportunities of parallelism in their programs, without worrying low-level

jane/doc/extensions/_04-modes/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ OCaml.
1111

1212
The mode system in the compiler tracks various properties of values, so that certain
1313
performance-enhancing operations can be performed safely. For example:
14-
- Locality tracks escaping. See [the local allocations reference](../stack/reference)
15-
- Uniqueness and linearity tracks aliasing. See [the uniqueness reference](../uniqueness/reference)
14+
- Locality tracks escaping. See [the local allocations reference](../../stack/reference)
15+
- Uniqueness and linearity tracks aliasing. See [the uniqueness reference](../../uniqueness/reference)
1616
- Portability and contention tracks inter-thread sharing.
1717
<!-- CR zqian: reference for portability and contention -->
1818

jane/doc/extensions/_05-kinds/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ less precise kind is expected.
3737
This page describes the kind system at a high level, and contains complete
3838
details for the non-modal bounds. It does not exhaustively describe the possible
3939
layouts (which are documented on the [unboxed types
40-
page](../unboxed-types/index)) or the modal axes (which are documented on the
41-
[modes page](../modes/intro)), but does explain how those components appear in
40+
page](../../unboxed-types/index)) or the modal axes (which are documented on the
41+
[modes page](../../modes/intro)), but does explain how those components appear in
4242
kinds, including how the modal bounds are affected by the with-bounds.
4343

4444
CR ccasinghino: add links to modes documentation after moving it here.

jane/doc/extensions/_05-kinds/syntax.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ title: Syntax
66

77
# Syntax for kind annotations
88

9-
[overview]: intro
10-
[manual]: https://ocaml.org/manual/latest/language.html
11-
[unboxed types]: ../unboxed-types/intro
12-
[nullability]: non-modal#nullability
13-
[externality]: non-modal#externality
9+
[overview]: ../intro
10+
[manual]: https://ocaml.org/manual/language.html
11+
[unboxed types]: ../../unboxed-types/intro
12+
[nullability]: ../non-modal#nullability
13+
[externality]: ../non-modal#externality
1414

1515
This page describes user-facing concerns about kind annotations. You may
1616
want to read an [overview][] of the kind system first.
@@ -461,8 +461,8 @@ field_type ::= typexpr [ @@ modalities ]
461461
```
462462

463463
Please see other OxCaml documentation for details on the syntax for
464-
[`modality`](../modes/syntax);
465-
[typexpr](https://ocaml.org/manual/latest/types.html) is defined in the OCaml
464+
[`modality`](../../modes/syntax);
465+
[typexpr](https://ocaml.org/manual/types.html) is defined in the OCaml
466466
manual.
467467

468468
Kind annotations are allowed at several places in the syntax.

jane/doc/extensions/_05-kinds/types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Kinds of types
66

77
# Kinds of types
88

9-
[overview]: intro
9+
[overview]: ../intro
1010

1111
This page describes how we compute the kind of both built-in types and
1212
user-defined types. You may want to read the [overview][] of the kind

jane/doc/extensions/_06-uniqueness/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: Intro
88

99
See also the full feature [reference](../reference) and [common
1010
pitfalls](../pitfalls). In this document, we use the new [syntax for
11-
modes](../modes/syntax).
11+
modes](../../modes/syntax).
1212

1313
The `unique` mode designates values that have only a single reference pointing
1414
to them. If an operation takes a `unique` argument, it will consume the only
@@ -42,7 +42,7 @@ let delay_free : t @ unique -> (unit -> unit) @ once = fun t -> fun () -> free t
4242

4343
These modes form two mode axes: the _uniqueness_ of a value is either `unique`
4444
or `aliased`, while the _affinity_ of a value is `once` or `many`. Similar to
45-
[locality](../stack/intro), uniqueness and affinity are deep properties. If a
45+
[locality](../../stack/intro), uniqueness and affinity are deep properties. If a
4646
value is at mode `unique` then all of its children are also `unique`. If a value
4747
is `once` then all of the closures it contains are also at mode `once`.
4848

jane/doc/extensions/_07-comprehensions/02-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ comprehensions](../intro).
1313
## Syntax
1414

1515
The BNF for comprehensions, in a form suitable for being added to the [grammar of
16-
OCaml](https://v2.ocaml.org/manual/expr.html), is
16+
OCaml](https://ocaml.org/manual/expr.html), is
1717

1818
```
1919
expr +::=

jane/doc/extensions/_08-miscellaneous-extensions/simd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ float64x2#
3636
The types ending with `#` are unboxed: they are passed between functions in XMM
3737
registers, stored in structures as flat data, and may be stored in flat arrays.
3838
The operations provided by `Ocaml_simd_sse` operate on unboxed vectors. For
39-
more detail on unboxed types, see the [docs](../unboxed-types/intro).
39+
more detail on unboxed types, see the [docs](../../unboxed-types/intro).
4040

4141
The types without `#` are boxed: when passed to a non-inlined function, they
4242
will be copied to a heap allocated (abstract) block. Boxed vectors are not

0 commit comments

Comments
 (0)