Skip to content

Commit ec3b62e

Browse files
authored
(doc) Update the VM.build flowchart, include it where useful for context (xapi-project#6301)
Merge a small, duplicated flowchart into one and include it where useful for context.
2 parents f4f00b3 + e73476e commit ec3b62e

File tree

3 files changed

+33
-30
lines changed

3 files changed

+33
-30
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
hidden: true
3+
title: VM_build micro-op flowchart
4+
description: For inclusion in _index.md and VM_build.md
5+
weight: 10
6+
---
7+
8+
```mermaid
9+
flowchart
10+
subgraph xenopsd VM_build[xenopsd: VM_build micro#8209;op]
11+
direction LR
12+
VM_build --> VM.build
13+
VM.build --> VM.build_domain
14+
VM.build_domain --> VM.build_domain_exn
15+
VM.build_domain_exn --> Domain.build
16+
click VM_build "
17+
https://github.com/xapi-project/xen-api/blob/83555067/ocaml/xenopsd/lib/xenops_server.ml#L2255-L2271" _blank
18+
click VM.build "
19+
https://github.com/xapi-project/xen-api/blob/83555067/ocaml/xenopsd/xc/xenops_server_xen.ml#L2290-L2291" _blank
20+
click VM.build_domain "
21+
https://github.com/xapi-project/xen-api/blob/83555067/ocaml/xenopsd/xc/xenops_server_xen.ml#L2250-L2288" _blank
22+
click VM.build_domain_exn "
23+
https://github.com/xapi-project/xen-api/blob/83555067/ocaml/xenopsd/xc/xenops_server_xen.ml#L2024-L2248" _blank
24+
click Domain.build "
25+
https://github.com/xapi-project/xen-api/blob/83555067/ocaml/xenopsd/xc/domain.ml#L1111-L1210" _blank
26+
end
27+
```

doc/content/xenopsd/walkthroughs/VM.build/VM_build.md

+3-15
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: VM_build micro-op
33
linkTitle: VM_build μ-op
44
description: Overview of the VM_build μ-op (runs after the VM_create μ-op created the domain).
55
weight: 10
6+
mermaid:
7+
force: true
68
---
79

810
## Overview
@@ -23,21 +25,7 @@ which calls
2325
[VM.build_domain_exn](https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2024-L2248)
2426
which calls [Domain.build](Domain.build):
2527

26-
```mermaid
27-
flowchart
28-
subgraph xenopsd VM_build[xenopsd VM_build micro#8209;op]
29-
direction LR
30-
VM_build --> VM.build
31-
VM.build --> VM.build_domain
32-
VM.build_domain --> VM.build_domain_exn
33-
VM.build_domain_exn --> Domain.build
34-
click VM_build "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/lib/xenops_server.ml#L2255-L2271" _blank
35-
click VM.build "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2290-L2291" _blank
36-
click VM.build_domain "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2250-L2288" _blank
37-
click VM.build_domain_exn "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2024-L2248" _blank
38-
click Domain.build "../Domain.build/index.html"
39-
end
40-
```
28+
{{% include "VM_build-chart.md" %}}
4129

4230
The function
4331
[VM.build_domain_exn](https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2024)

doc/content/xenopsd/walkthroughs/VM.build/_index.md

+3-15
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,11 @@
22
title: Building a VM
33
description: After VM_create, VM_build builds the core of the domain (vCPUs, memory)
44
weight: 20
5+
mermaid:
6+
force: true
57
---
8+
{{% include "VM_build-chart.md" %}}
69

710
Walk-through documents for the `VM_build` phase:
811

9-
```mermaid
10-
flowchart
11-
subgraph xenopsd VM_build[xenopsd VM_build micro#8209;op]
12-
direction LR
13-
VM_build --> VM.build
14-
VM.build --> VM.build_domain
15-
VM.build_domain --> VM.build_domain_exn
16-
VM.build_domain_exn --> Domain.build
17-
click VM_build "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/lib/xenops_server.ml#L2255-L2271" _blank
18-
click VM.build "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2290-L2291" _blank
19-
click VM.build_domain "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2250-L2288" _blank
20-
click VM.build_domain_exn "https://github.com/xapi-project/xen-api/blob/master/ocaml/xenopsd/xc/xenops_server_xen.ml#L2024-L2248" _blank
21-
end
22-
```
23-
2412
{{% children description=true %}}

0 commit comments

Comments
 (0)