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]>
kata-containers · Nov 10, 2020 · 849f17c · 849f17c
1 parent bce2528
commit 849f17c
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 20 deletions.
diff --git a/cli/config/configuration-acrn.toml.in b/cli/config/configuration-acrn.toml.in
@@ -21,11 +21,15 @@ image = "@IMAGEPATH@"
 # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
 enable_annotations = @DEFENABLEANNOTATIONS@
 
-# List of valid annotations values for the hypervisor (default: empty)
+# List of valid annotations values for the hypervisor
 # Each member of the list is a path pattern as described by glob(3).
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @ACRNPATHLIST@
 path_list = @ACRNPATHLIST@
 
-# List of valid annotations values for ctlpath (default: empty)
+# List of valid annotations values for ctlpath
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @ACRNCTLPATHLIST@
 ctlpath_list = @ACRNCTLPATHLIST@
 
 # Optional space-separated list of options to pass to the guest kernel.
@@ -251,6 +255,6 @@ experimental=@DEFAULTEXPFEATURES@
 # If enabled, containers are allowed to join the pid namespace of the agent
 # when the env variable KATA_AGENT_PIDNS is set for a container.
 # Use this with caution and only when required, as this option allows the container
-# to access the agent process. It is recommended to enable this option 
+# to access the agent process. It is recommended to enable this option
 # only in debug scenarios and with containers with lowered priveleges.
 #enable_agent_pidns = true
diff --git a/cli/config/configuration-clh.toml.in b/cli/config/configuration-clh.toml.in
@@ -20,8 +20,10 @@ image = "@IMAGEPATH@"
 # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
 enable_annotations = @DEFENABLEANNOTATIONS@
 
-# List of valid annotations values for the hypervisor (default: empty)
+# List of valid annotations values for the hypervisor
 # Each member of the list is a path pattern as described by glob(3).
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @CLHPATHLIST@
 path_list = @CLHPATHLIST@
 
 # Optional space-separated list of options to pass to the guest kernel.
@@ -71,7 +73,9 @@ default_memory = @DEFMEMSZ@
 # Path to vhost-user-fs daemon.
 virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
 
-# List of valid annotations values for the virtiofs daemon (default: empty)
+# List of valid annotations values for the virtiofs daemon
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
 virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
 
 # Default size of DAX cache in MiB
@@ -252,6 +256,6 @@ experimental=@DEFAULTEXPFEATURES@
 # If enabled, containers are allowed to join the pid namespace of the agent
 # when the env variable KATA_AGENT_PIDNS is set for a container.
 # Use this with caution and only when required, as this option allows the container
-# to access the agent process. It is recommended to enable this option 
+# to access the agent process. It is recommended to enable this option
 # only in debug scenarios and with containers with lowered priveleges.
 #enable_agent_pidns = true
diff --git a/cli/config/configuration-fc.toml.in b/cli/config/configuration-fc.toml.in
@@ -20,8 +20,10 @@ image = "@IMAGEPATH@"
 # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
 enable_annotations = @DEFENABLEANNOTATIONS@
 
-# List of valid annotations values for the hypervisor (default: empty)
+# List of valid annotations values for the hypervisor
 # Each member of the list is a path pattern as described by glob(3).
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @FCPATHLIST@
 path_list = @FCPATHLIST@
 
 # Path for the jailer specific to firecracker
@@ -32,9 +34,11 @@ path_list = @FCPATHLIST@
 # for this feature today.
 #jailer_path = "@FCJAILERPATH@"
 
-# List of valid jailer path values for the hypervisor (default: empty)
+# List of valid jailer path values for the hypervisor
 # Each member of the list can be a regular expression
-# jailer_path_list = @FCJAILERPATHLIST@
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @FCJAILERPATHLIST@
+jailer_path_list = @FCJAILERPATHLIST@
 
 
 # Optional space-separated list of options to pass to the guest kernel.
@@ -363,6 +367,6 @@ experimental=@DEFAULTEXPFEATURES@
 # If enabled, containers are allowed to join the pid namespace of the agent
 # when the env variable KATA_AGENT_PIDNS is set for a container.
 # Use this with caution and only when required, as this option allows the container
-# to access the agent process. It is recommended to enable this option 
+# to access the agent process. It is recommended to enable this option
 # only in debug scenarios and with containers with lowered priveleges.
 #enable_agent_pidns = true
diff --git a/cli/config/configuration-qemu-virtiofs.toml.in b/cli/config/configuration-qemu-virtiofs.toml.in
@@ -19,10 +19,14 @@ machine_type = "@MACHINETYPE@"
 # List of valid annotation names for the hypervisor
 # Each member of the list is a regular expression, which is the base name
 # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFENABLEANNOTATIONS@
 enable_annotations = @DEFENABLEANNOTATIONS@
 
-# List of valid annotations values for the hypervisor (default: empty)
+# List of valid annotations values for the hypervisor
 # Each member of the list is a path pattern as described by glob(3).
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @QEMUVIRTIOFSPATHLIST@
 path_list = @QEMUVIRTIOFSPATHLIST@
 
 # Optional space-separated list of options to pass to the guest kernel.
@@ -119,7 +123,9 @@ shared_fs = "@DEFSHAREDFS_QEMU_VIRTIOFS@"
 # Path to vhost-user-fs daemon.
 virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
 
-# List of valid annotations values for the virtiofs daemon (default: empty)
+# List of valid annotations values for the virtiofs daemon
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
 virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
 
 # Default size of DAX cache in MiB
@@ -211,7 +217,9 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
 # Enabling this will result in the VM device having iommu_platform=on set
 #enable_iommu_platform = true
 
-# List of valid annotations values for the virtiofs daemon (default: empty)
+# List of valid annotations values for the virtiofs daemon
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFVHOSTUSERSTOREPATHLIST@
 vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
 
 # Enable file based guest memory support. The default is an empty string which
@@ -220,8 +228,10 @@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
 # This option will be ignored if VM templating is enabled.
 #file_mem_backend = "@DEFFILEMEMBACKEND@"
 
-# List of valid annotations values for the file_mem_backend annotation (default: empty)
-#file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
+# List of valid annotations values for the file_mem_backend annotation
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFFILEMEMBACKENDLIST@
+file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
 
 # Enable swap of vm memory. Default false.
 # The behaviour is undefined if mem_prealloc is also set to true

diff --git a/cli/config/configuration-qemu.toml.in b/cli/config/configuration-qemu.toml.in
@@ -22,8 +22,10 @@ machine_type = "@MACHINETYPE@"
 # of the annotation, e.g. "path" for io.katacontainers.config.hypervisor.path"
 enable_annotations = @DEFENABLEANNOTATIONS@
 
-# List of valid annotations values for the hypervisor (default: empty)
+# List of valid annotations values for the hypervisor
 # Each member of the list is a path pattern as described by glob(3).
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @QEMUPATHLIST@
 path_list = @QEMUPATHLIST@
 
 # Optional space-separated list of options to pass to the guest kernel.
@@ -126,7 +128,9 @@ shared_fs = "@DEFSHAREDFS@"
 # Path to vhost-user-fs daemon.
 virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@"
 
-# List of valid annotations values for the virtiofs daemon (default: empty)
+# List of valid annotations values for the virtiofs daemon
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFVIRTIOFSDAEMONLIST@
 virtio_fs_daemon_list = @DEFVIRTIOFSDAEMONLIST@
 
 # Default size of DAX cache in MiB
@@ -218,7 +222,9 @@ vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@"
 # Enabling this will result in the VM device having iommu_platform=on set
 #enable_iommu_platform = true
 
-# List of valid annotations values for the vhost user store path (default: empty)
+# List of valid annotations values for the vhost user store path
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFVHOSTUSERSTOREPATHLIST@
 vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
 
 # Enable file based guest memory support. The default is an empty string which
@@ -227,8 +233,10 @@ vhost_user_store_path_list = @DEFVHOSTUSERSTOREPATHLIST@
 # This option will be ignored if VM templating is enabled.
 #file_mem_backend = "@DEFFILEMEMBACKEND@"
 
-# List of valid annotations values for the file_mem_backend annotation (default: empty)
-#file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
+# List of valid annotations values for the file_mem_backend annotation
+# The default if not set is empty (all annotations rejected.)
+# Your distribution recommends: @DEFFILEMEMBACKENDLIST@
+file_mem_backend_list = @DEFFILEMEMBACKENDLIST@
 
 # Enable swap of vm memory. Default false.
 # The behaviour is undefined if mem_prealloc is also set to true