Skip to content
This repository was archived by the owner on May 12, 2021. It is now read-only.

Commit cf3a7eb

Browse files
c3dc3d
committed
config: Improve comments in configuration file templates
During review, Julio Montes found the term "annotation value" ambiguous. Specify each time that this is a path. Also fixed a grammatical error (annotations value -> annotation value) Suggested-by: Julio Montes <[email protected]> Signed-off-by: Christophe de Dinechin <[email protected]>
1 parent 31f0ed5 commit cf3a7eb

File tree

5 files changed

+21
-13
lines changed

5 files changed

+21
-13
lines changed

‎cli/config/configuration-acrn.toml.in‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@ image = "@IMAGEPATH@"
2323
# Your distribution recommends: @DEFENABLEANNOTATIONS@
2424
enable_annotations = @DEFENABLEANNOTATIONS@
2525

26-
# List of valid annotations values for the hypervisor
26+
# List of valid annotation values for the hypervisor path
2727
# Each member of the list is a path pattern as described by glob(3).
2828
# The default if not set is empty (all annotations rejected.)
2929
# Your distribution recommends: @ACRNVALIDHYPERVISORPATHS@
3030
valid_hypervisor_paths = @ACRNVALIDHYPERVISORPATHS@
3131

32-
# List of valid annotations values for ctlpath
32+
# List of valid annotation values for ctl path
33+
# Each member of the list is a path pattern as described by glob(3).
3334
# The default if not set is empty (all annotations rejected.)
3435
# Your distribution recommends: @ACRNVALIDCTLPATHS@
3536
valid_ctlpaths = @ACRNVALIDCTLPATHS@

‎cli/config/configuration-clh.toml.in‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ image = "@IMAGEPATH@"
2222
# Your distribution recommends: @DEFENABLEANNOTATIONS@
2323
enable_annotations = @DEFENABLEANNOTATIONS@
2424

25-
# List of valid annotations values for the hypervisor
25+
# List of valid annotation values for the hypervisor path
2626
# Each member of the list is a path pattern as described by glob(3).
2727
# The default if not set is empty (all annotations rejected.)
2828
# Your distribution recommends: @CLHVALIDHYPERVISORPATHS@
@@ -75,7 +75,8 @@ default_memory = @DEFMEMSZ@
7575
# Path to vhost-user-fs daemon.
7676
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
7777

78-
# List of valid annotations values for the virtiofs daemon
78+
# List of valid annotation values for the virtiofs daemon path
79+
# Each member of the list is a path pattern as described by glob(3).
7980
# The default if not set is empty (all annotations rejected.)
8081
# Your distribution recommends: @DEFVALIDVIRTIOFSDAEMONPATHS@
8182
valid_virtio_fs_daemon_paths = @DEFVALIDVIRTIOFSDAEMONPATHS@

‎cli/config/configuration-fc.toml.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ image = "@IMAGEPATH@"
2222
# Your distribution recommends: @DEFENABLEANNOTATIONS@
2323
enable_annotations = @DEFENABLEANNOTATIONS@
2424

25-
# List of valid annotations values for the hypervisor
25+
# List of valid annotation values for the hypervisor path
2626
# Each member of the list is a path pattern as described by glob(3).
2727
# The default if not set is empty (all annotations rejected.)
2828
# Your distribution recommends: @FCVALIDHYPERVISORPATHS@

‎cli/config/configuration-qemu-virtiofs.toml.in‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ machine_type = "@MACHINETYPE@"
2323
# Your distribution recommends: @DEFENABLEANNOTATIONS@
2424
enable_annotations = @DEFENABLEANNOTATIONS@
2525

26-
# List of valid annotations values for the hypervisor
26+
# List of valid annotation values for the hypervisor path
2727
# Each member of the list is a path pattern as described by glob(3).
2828
# The default if not set is empty (all annotations rejected.)
2929
# Your distribution recommends: @QEMUVALIDHYPERVISORPATHS@
@@ -123,7 +123,8 @@ shared_fs = "@DEFSHAREDFS_QEMU_VIRTIOFS@"
123123
# Path to vhost-user-fs daemon.
124124
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
125125

126-
# List of valid annotations values for the virtiofs daemon
126+
# List of valid annotation values for the virtiofs daemon path
127+
# Each member of the list is a path pattern as described by glob(3).
127128
# The default if not set is empty (all annotations rejected.)
128129
# Your distribution recommends: @DEFVALIDVIRTIOFSDAEMONPATHS@
129130
valid_virtio_fs_daemon_paths = @DEFVALIDVIRTIOFSDAEMONPATHS@
@@ -217,7 +218,8 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
217218
# Enabling this will result in the VM device having iommu_platform=on set
218219
#enable_iommu_platform = true
219220

220-
# List of valid annotations values for the virtiofs daemon
221+
# List of valid annotation values for the virtiofs daemon path
222+
# Each member of the list is a path pattern as described by glob(3).
221223
# The default if not set is empty (all annotations rejected.)
222224
# Your distribution recommends: @DEFVALIDVHOSTUSERSTOREPATHS@
223225
valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@
@@ -228,7 +230,8 @@ valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@
228230
# This option will be ignored if VM templating is enabled.
229231
#file_mem_backend = "@DEFFILEMEMBACKEND@"
230232

231-
# List of valid annotations values for the file_mem_backend annotation
233+
# List of valid annotation values for the file_mem_backend path
234+
# Each member of the list is a path pattern as described by glob(3).
232235
# The default if not set is empty (all annotations rejected.)
233236
# Your distribution recommends: @DEFVALIDVHOSTUSERSTOREPATHS@
234237
valid_file_mem_backends = @DEFVALIDFILEMEMBACKENDS@

‎cli/config/configuration-qemu.toml.in‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ machine_type = "@MACHINETYPE@"
2424
# Your distribution recommends: @DEFENABLEANNOTATIONS@
2525
enable_annotations = @DEFENABLEANNOTATIONS@
2626

27-
# List of valid annotations values for the hypervisor
27+
# List of valid annotation values for the hypervisor path
2828
# Each member of the list is a path pattern as described by glob(3).
2929
# The default if not set is empty (all annotations rejected.)
3030
# Your distribution recommends: @QEMUVALIDHYPERVISORPATHS@
@@ -130,7 +130,8 @@ shared_fs = "@DEFSHAREDFS@"
130130
# Path to vhost-user-fs daemon.
131131
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
132132

133-
# List of valid annotations values for the virtiofs daemon
133+
# List of valid annotation values for the virtiofs daemon path
134+
# Each member of the list is a path pattern as described by glob(3).
134135
# The default if not set is empty (all annotations rejected.)
135136
# Your distribution recommends: @DEFVALIDVIRTIOFSDAEMONPATHS@
136137
valid_virtio_fs_daemon_paths = @DEFVALIDVIRTIOFSDAEMONPATHS@
@@ -224,7 +225,8 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
224225
# Enabling this will result in the VM device having iommu_platform=on set
225226
#enable_iommu_platform = true
226227

227-
# List of valid annotations values for the vhost user store path
228+
# List of valid annotation values for the vhost user store path
229+
# Each member of the list is a path pattern as described by glob(3).
228230
# The default if not set is empty (all annotations rejected.)
229231
# Your distribution recommends: @DEFVALIDVHOSTUSERSTOREPATHS@
230232
valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@
@@ -235,7 +237,8 @@ valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@
235237
# This option will be ignored if VM templating is enabled.
236238
#file_mem_backend = "@DEFFILEMEMBACKEND@"
237239

238-
# List of valid annotations values for the file_mem_backend annotation
240+
# List of valid annotation values for the file_mem_backend path
241+
# Each member of the list is a path pattern as described by glob(3).
239242
# The default if not set is empty (all annotations rejected.)
240243
# Your distribution recommends: @DEFVALIDFILEMEMBACKENDS@
241244
valid_file_mem_backends = @DEFVALIDFILEMEMBACKENDS@

0 commit comments

Comments
 (0)