[PATCH 04/22] Documentation: explain VM shared directories

Alyssa Ross
2022-10-10T23:32:28Z

Documentation/_sass/custom/custom.scss | 22 ++++++++++++++++++++++
Documentation/creating-vms.adoc | 8 ++++++++
2 files changed, 30 insertions(+)
create mode 100644 Documentation/_sass/custom/custom.scss

diff --git a/Documentation/_sass/custom/custom.scss b/Documentation/_sass/custom/custom.scss
new file mode 100644
index 0000000..eb50c81
--- /dev/null
+++ b/Documentation/_sass/custom/custom.scss
@@ -0,0 +1,22 @@
+// SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is>
+// SPDX-License-Identifier: MIT
+
+.main-content {
+ // Just the Docs puts titles next to definitions, rather than on
+ // the line before. This makes the definitions too horizontally
+ // compressed.
+ dl {
+ display: block;
+ }
+ dt {
+ text-align: left;
+ font-weight: bold;
+
+ &::after {
+ content: none;
+ }
+ }
+ dd {
+ margin-left: 2ch;
+ }
+}
diff --git a/Documentation/creating-vms.adoc b/Documentation/creating-vms.adoc
index 6d4fde0..efae489 100644
--- a/Documentation/creating-vms.adoc
+++ b/Documentation/creating-vms.adoc
@@ -19,6 +19,14 @@ blk:: A directory containing disk images (with file names ending in
".img") that will be provided to the guest as a virtio-blk device.
Order is not guaranteed. At least one image is *required*.

+shared-dirs:: A directory whose *subdirectories* each describe a
+directory to be shared with a VM. The name of each subdirectory is
+used as the virtiofs tag, and the contents are as follows:
+
+ dir::: A symbolic link pointing to the directory to be shared with
+ the VM. The directory must be on the xref:user-partition.adoc[user
+ data partition]. *Required.*
+
providers/net:: A directory containing a file named for each VM that
should provide networking to this VM. The contents of these files are
ignored.
--
2.37.1