From 7c1bf8298857b232f2e354ccef84906c21699d6e Mon Sep 17 00:00:00 2001 From: Christophe de Dinechin Date: Fri, 23 Oct 2020 08:35:06 +0200 Subject: [PATCH] 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 Signed-off-by: Christophe de Dinechin --- cli/config/configuration-acrn.toml.in | 5 +++-- cli/config/configuration-clh.toml.in | 5 +++-- cli/config/configuration-fc.toml.in | 2 +- cli/config/configuration-qemu-virtiofs.toml.in | 11 +++++++---- cli/config/configuration-qemu.toml.in | 11 +++++++---- 5 files changed, 21 insertions(+), 13 deletions(-) diff --git a/cli/config/configuration-acrn.toml.in b/cli/config/configuration-acrn.toml.in index 3062c589c8..ea6fae5313 100644 --- a/cli/config/configuration-acrn.toml.in +++ b/cli/config/configuration-acrn.toml.in @@ -23,13 +23,14 @@ image = "@IMAGEPATH@" # Your distribution recommends: @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@ -# List of valid annotations values for the hypervisor +# List of valid annotation values for the hypervisor path # 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: @ACRNVALIDHYPERVISORPATHS@ valid_hypervisor_paths = @ACRNVALIDHYPERVISORPATHS@ -# List of valid annotations values for ctlpath +# List of valid annotation values for ctl path +# 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: @ACRNVALIDCTLPATHS@ valid_ctlpaths = @ACRNVALIDCTLPATHS@ diff --git a/cli/config/configuration-clh.toml.in b/cli/config/configuration-clh.toml.in index abad302b08..92009dfc50 100644 --- a/cli/config/configuration-clh.toml.in +++ b/cli/config/configuration-clh.toml.in @@ -22,7 +22,7 @@ image = "@IMAGEPATH@" # Your distribution recommends: @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@ -# List of valid annotations values for the hypervisor +# List of valid annotation values for the hypervisor path # 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: @CLHVALIDHYPERVISORPATHS@ @@ -75,7 +75,8 @@ default_memory = @DEFMEMSZ@ # Path to vhost-user-fs daemon. virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@" -# List of valid annotations values for the virtiofs daemon +# List of valid annotation values for the virtiofs daemon path +# 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: @DEFVALIDVIRTIOFSDAEMONPATHS@ valid_virtio_fs_daemon_paths = @DEFVALIDVIRTIOFSDAEMONPATHS@ diff --git a/cli/config/configuration-fc.toml.in b/cli/config/configuration-fc.toml.in index 225b33e9a9..4930652b54 100644 --- a/cli/config/configuration-fc.toml.in +++ b/cli/config/configuration-fc.toml.in @@ -22,7 +22,7 @@ image = "@IMAGEPATH@" # Your distribution recommends: @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@ -# List of valid annotations values for the hypervisor +# List of valid annotation values for the hypervisor path # 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: @FCVALIDHYPERVISORPATHS@ diff --git a/cli/config/configuration-qemu-virtiofs.toml.in b/cli/config/configuration-qemu-virtiofs.toml.in index b083cd0a94..a3e32e7c85 100644 --- a/cli/config/configuration-qemu-virtiofs.toml.in +++ b/cli/config/configuration-qemu-virtiofs.toml.in @@ -23,7 +23,7 @@ machine_type = "@MACHINETYPE@" # Your distribution recommends: @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@ -# List of valid annotations values for the hypervisor +# List of valid annotation values for the hypervisor path # 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: @QEMUVALIDHYPERVISORPATHS@ @@ -117,7 +117,8 @@ shared_fs = "@DEFSHAREDFS_QEMU_VIRTIOFS@" # Path to vhost-user-fs daemon. virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@" -# List of valid annotations values for the virtiofs daemon +# List of valid annotation values for the virtiofs daemon path +# 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: @DEFVALIDVIRTIOFSDAEMONPATHS@ valid_virtio_fs_daemon_paths = @DEFVALIDVIRTIOFSDAEMONPATHS@ @@ -201,7 +202,8 @@ enable_vhost_user_store = @DEFENABLEVHOSTUSERSTORE@ # simulated block device nodes for vhost-user devices to live. vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@" -# List of valid annotations values for the virtiofs daemon +# List of valid annotation values for the virtiofs daemon path +# 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: @DEFVALIDVHOSTUSERSTOREPATHS@ valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@ @@ -212,7 +214,8 @@ valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@ # 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 +# List of valid annotation values for the file_mem_backend path +# 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: @DEFVALIDVHOSTUSERSTOREPATHS@ valid_file_mem_backends = @DEFVALIDFILEMEMBACKENDS@ diff --git a/cli/config/configuration-qemu.toml.in b/cli/config/configuration-qemu.toml.in index 3e1f7e111f..b990c3121b 100644 --- a/cli/config/configuration-qemu.toml.in +++ b/cli/config/configuration-qemu.toml.in @@ -24,7 +24,7 @@ machine_type = "@MACHINETYPE@" # Your distribution recommends: @DEFENABLEANNOTATIONS@ enable_annotations = @DEFENABLEANNOTATIONS@ -# List of valid annotations values for the hypervisor +# List of valid annotation values for the hypervisor path # 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: @QEMUVALIDHYPERVISORPATHS@ @@ -124,7 +124,8 @@ shared_fs = "@DEFSHAREDFS@" # Path to vhost-user-fs daemon. virtio_fs_daemon = "@DEFVIRTIOFSDAEMON@" -# List of valid annotations values for the virtiofs daemon +# List of valid annotation values for the virtiofs daemon path +# 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: @DEFVALIDVIRTIOFSDAEMONPATHS@ valid_virtio_fs_daemon_paths = @DEFVALIDVIRTIOFSDAEMONPATHS@ @@ -208,7 +209,8 @@ enable_vhost_user_store = @DEFENABLEVHOSTUSERSTORE@ # simulated block device nodes for vhost-user devices to live. vhost_user_store_path = "@DEFVHOSTUSERSTOREPATH@" -# List of valid annotations values for the vhost user store path +# List of valid annotation values for the vhost user store path +# 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: @DEFVALIDVHOSTUSERSTOREPATHS@ valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@ @@ -219,7 +221,8 @@ valid_vhost_user_store_paths = @DEFVALIDVHOSTUSERSTOREPATHS@ # 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 +# List of valid annotation values for the file_mem_backend path +# 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: @DEFVALIDFILEMEMBACKENDS@ valid_file_mem_backends = @DEFVALIDFILEMEMBACKENDS@