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

Commit

Permalink
config: Improve comments in configuration file templates
Browse files Browse the repository at this point in the history
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 <julio.montes@intel.com>
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
  • Loading branch information
c3d authored and fidencio committed Nov 11, 2020
1 parent 57a29a8 commit 7c1bf82
Showing 5 changed files with 21 additions and 13 deletions.
5 changes: 3 additions & 2 deletions cli/config/configuration-acrn.toml.in
Original file line number Diff line number Diff line change
@@ -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@
5 changes: 3 additions & 2 deletions cli/config/configuration-clh.toml.in
Original file line number Diff line number Diff line change
@@ -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@
2 changes: 1 addition & 1 deletion cli/config/configuration-fc.toml.in
Original file line number Diff line number Diff line change
@@ -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@
11 changes: 7 additions & 4 deletions cli/config/configuration-qemu-virtiofs.toml.in
Original file line number Diff line number Diff line change
@@ -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@
11 changes: 7 additions & 4 deletions cli/config/configuration-qemu.toml.in
Original file line number Diff line number Diff line change
@@ -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@

0 comments on commit 7c1bf82

Please sign in to comment.