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

Commit 96ba05f

Browse files
c3dfidencio
c3d
authored and
fidencio
committed
config: Add better comments in the template files
When there is a default value from the code (usually empty) that differs from a possible suggested value from the distro, then the wording "default: empty" is confusing. Fixes: #3004 Suggested-by: Julio Montes <[email protected]> Signed-off-by: Christophe de Dinechin <[email protected]>
1 parent 33021ef commit 96ba05f

File tree

5 files changed

+47
-17
lines changed

5 files changed

+47
-17
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,15 @@ image = "@IMAGEPATH@"
2121
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
2222
enable_annotations = @DEFENABLEANNOTATIONS@
2323

24-
# List of valid annotations values for the hypervisor (default: empty)
24+
# List of valid annotations values for the hypervisor
2525
# Each member of the list is a path pattern as described by glob(3).
26+
# The default if not set is empty (all annotations rejected.)
27+
# Your distribution recommends: @ACRNPATHLIST@
2628
path_list = @ACRNPATHLIST@
2729

28-
# List of valid annotations values for ctlpath (default: empty)
30+
# List of valid annotations values for ctlpath
31+
# The default if not set is empty (all annotations rejected.)
32+
# Your distribution recommends: @ACRNCTLPATHLIST@
2933
ctlpath_list = @ACRNCTLPATHLIST@
3034

3135
# Optional space-separated list of options to pass to the guest kernel.

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@ image = "@IMAGEPATH@"
2020
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
2121
enable_annotations = @DEFENABLEANNOTATIONS@
2222

23-
# List of valid annotations values for the hypervisor (default: empty)
23+
# List of valid annotations values for the hypervisor
2424
# Each member of the list is a path pattern as described by glob(3).
25+
# The default if not set is empty (all annotations rejected.)
26+
# Your distribution recommends: @CLHPATHLIST@
2527
path_list = @CLHPATHLIST@
2628

2729
# Optional space-separated list of options to pass to the guest kernel.
@@ -71,7 +73,9 @@ default_memory = @DEFMEMSZ@
7173
# Path to vhost-user-fs daemon.
7274
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
7375

74-
# List of valid annotations values for the virtiofs daemon (default: empty)
76+
# List of valid annotations values for the virtiofs daemon
77+
# The default if not set is empty (all annotations rejected.)
78+
# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
7579
virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
7680

7781
# Default size of DAX cache in MiB

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@ image = "@IMAGEPATH@"
2020
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
2121
enable_annotations = @DEFENABLEANNOTATIONS@
2222

23-
# List of valid annotations values for the hypervisor (default: empty)
23+
# List of valid annotations values for the hypervisor
2424
# Each member of the list is a path pattern as described by glob(3).
25+
# The default if not set is empty (all annotations rejected.)
26+
# Your distribution recommends: @FCPATHLIST@
2527
path_list = @FCPATHLIST@
2628

2729
# Path for the jailer specific to firecracker
@@ -32,9 +34,11 @@ path_list = @FCPATHLIST@
3234
# for this feature today.
3335
#jailer_path = "@FCJAILERPATH@"
3436

35-
# List of valid jailer path values for the hypervisor (default: empty)
37+
# List of valid jailer path values for the hypervisor
3638
# Each member of the list can be a regular expression
37-
# jailer_path_list = @FCJAILERPATHLIST@
39+
# The default if not set is empty (all annotations rejected.)
40+
# Your distribution recommends: @FCJAILERPATHLIST@
41+
jailer_path_list = @FCJAILERPATHLIST@
3842

3943

4044
# Optional space-separated list of options to pass to the guest kernel.

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

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,14 @@ machine_type = "@MACHINETYPE@"
1919
# List of valid annotation names for the hypervisor
2020
# Each member of the list is a regular expression, which is the base name
2121
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
22+
# The default if not set is empty (all annotations rejected.)
23+
# Your distribution recommends: @DEFENABLEANNOTATIONS@
2224
enable_annotations = @DEFENABLEANNOTATIONS@
2325

24-
# List of valid annotations values for the hypervisor (default: empty)
26+
# List of valid annotations values for the hypervisor
2527
# Each member of the list is a path pattern as described by glob(3).
28+
# The default if not set is empty (all annotations rejected.)
29+
# Your distribution recommends: @QEMUVIRTIOFSPATHLIST@
2630
path_list = @QEMUVIRTIOFSPATHLIST@
2731

2832
# Optional space-separated list of options to pass to the guest kernel.
@@ -113,7 +117,9 @@ shared_fs = "@DEFSHAREDFS_QEMU_VIRTIOFS@"
113117
# Path to vhost-user-fs daemon.
114118
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
115119

116-
# List of valid annotations values for the virtiofs daemon (default: empty)
120+
# List of valid annotations values for the virtiofs daemon
121+
# The default if not set is empty (all annotations rejected.)
122+
# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
117123
virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
118124

119125
# Default size of DAX cache in MiB
@@ -195,7 +201,9 @@ enable_vhost_user_store = @DEFENABLEVHOSTUSERSTORE@
195201
# simulated block device nodes for vhost-user devices to live.
196202
vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
197203

198-
# List of valid annotations values for the virtiofs daemon (default: empty)
204+
# List of valid annotations values for the virtiofs daemon
205+
# The default if not set is empty (all annotations rejected.)
206+
# Your distribution recommends: @DEFVHOSTUSERSTOREPATHLIST@
199207
vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
200208

201209
# Enable file based guest memory support. The default is an empty string which
@@ -204,8 +212,10 @@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
204212
# This option will be ignored if VM templating is enabled.
205213
#file_mem_backend = "@DEFFILEMEMBACKEND@"
206214

207-
# List of valid annotations values for the file_mem_backend annotation (default: empty)
208-
#file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
215+
# List of valid annotations values for the file_mem_backend annotation
216+
# The default if not set is empty (all annotations rejected.)
217+
# Your distribution recommends: @DEFFILEMEMBACKENDLIST@
218+
file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
209219

210220
# Enable swap of vm memory. Default false.
211221
# The behaviour is undefined if mem_prealloc is also set to true

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ machine_type = "@MACHINETYPE@"
2222
# of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
2323
enable_annotations = @DEFENABLEANNOTATIONS@
2424

25-
# List of valid annotations values for the hypervisor (default: empty)
25+
# List of valid annotations values for the hypervisor
2626
# Each member of the list is a path pattern as described by glob(3).
27+
# The default if not set is empty (all annotations rejected.)
28+
# Your distribution recommends: @QEMUPATHLIST@
2729
path_list = @QEMUPATHLIST@
2830

2931
# Optional space-separated list of options to pass to the guest kernel.
@@ -120,7 +122,9 @@ shared_fs = "@DEFSHAREDFS@"
120122
# Path to vhost-user-fs daemon.
121123
virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
122124

123-
# List of valid annotations values for the virtiofs daemon (default: empty)
125+
# List of valid annotations values for the virtiofs daemon
126+
# The default if not set is empty (all annotations rejected.)
127+
# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
124128
virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
125129

126130
# Default size of DAX cache in MiB
@@ -202,7 +206,9 @@ enable_vhost_user_store = @DEFENABLEVHOSTUSERSTORE@
202206
# simulated block device nodes for vhost-user devices to live.
203207
vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
204208

205-
# List of valid annotations values for the vhost user store path (default: empty)
209+
# List of valid annotations values for the vhost user store path
210+
# The default if not set is empty (all annotations rejected.)
211+
# Your distribution recommends: @DEFVHOSTUSERSTOREPATHLIST@
206212
vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
207213

208214
# Enable file based guest memory support. The default is an empty string which
@@ -211,8 +217,10 @@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
211217
# This option will be ignored if VM templating is enabled.
212218
#file_mem_backend = "@DEFFILEMEMBACKEND@"
213219

214-
# List of valid annotations values for the file_mem_backend annotation (default: empty)
215-
#file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
220+
# List of valid annotations values for the file_mem_backend annotation
221+
# The default if not set is empty (all annotations rejected.)
222+
# Your distribution recommends: @DEFFILEMEMBACKENDLIST@
223+
file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
216224

217225
# Enable swap of vm memory. Default false.
218226
# The behaviour is undefined if mem_prealloc is also set to true

0 commit comments

Comments
 (0)