diff mbox series

qapi/block: Document restrictions for node names

Message ID 20180806123728.13658-1-kwolf@redhat.com (mailing list archive)
State New, archived
Headers show
Series qapi/block: Document restrictions for node names | expand

Commit Message

Kevin Wolf Aug. 6, 2018, 12:37 p.m. UTC
blockdev-add fails if an invalid node name is given, so we should
document what a valid node name even is.

Reported-by: Cong Li <coli@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
 qapi/block-core.json | 3 +++
 1 file changed, 3 insertions(+)

Comments

Eric Blake Aug. 6, 2018, 2:19 p.m. UTC | #1
On 08/06/2018 07:37 AM, Kevin Wolf wrote:
> blockdev-add fails if an invalid node name is given, so we should
> document what a valid node name even is.
> 
> Reported-by: Cong Li <coli@redhat.com>
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> ---
>   qapi/block-core.json | 3 +++
>   1 file changed, 3 insertions(+)

Reviewed-by: Eric Blake <eblake@redhat.com>

> 
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 62a92fa4f4..fe565ebfaf 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -3563,6 +3563,9 @@
>   # @driver:        block driver name
>   # @node-name:     the node name of the new node (Since 2.0).
>   #                 This option is required on the top level of blockdev-add.
> +#                 Valid node names start with an alphabetic character and may
> +#                 contain only alphanumeric characters, '-', '.' and '_'. Their
> +#                 maximum length is 31 characters.
>   # @discard:       discard-related options (default: ignore)
>   # @cache:         cache-related options
>   # @read-only:     whether the block device should be read-only (default: false).
>
Cong Li Aug. 7, 2018, 2:38 a.m. UTC | #2
----- Original Message -----
> From: "Kevin Wolf" <kwolf@redhat.com>
> To: qemu-block@nongnu.org
> Cc: kwolf@redhat.com, coli@redhat.com, qemu-devel@nongnu.org
> Sent: Monday, August 6, 2018 8:37:28 PM
> Subject: [PATCH] qapi/block: Document restrictions for node names
> 
> blockdev-add fails if an invalid node name is given, so we should
> document what a valid node name even is.
> 
> Reported-by: Cong Li <coli@redhat.com>
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>

Reviewed-by: Cong Li <coli@redhat.com>

> ---
>  qapi/block-core.json | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 62a92fa4f4..fe565ebfaf 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -3563,6 +3563,9 @@
>  # @driver:        block driver name
>  # @node-name:     the node name of the new node (Since 2.0).
>  #                 This option is required on the top level of blockdev-add.
> +#                 Valid node names start with an alphabetic character and
> may
> +#                 contain only alphanumeric characters, '-', '.' and '_'.
> Their
> +#                 maximum length is 31 characters.
>  # @discard:       discard-related options (default: ignore)
>  # @cache:         cache-related options
>  # @read-only:     whether the block device should be read-only (default:
>  false).
> --
> 2.13.6
> 
>
Alberto Garcia Aug. 7, 2018, 11:13 a.m. UTC | #3
On Mon 06 Aug 2018 02:37:28 PM CEST, Kevin Wolf wrote:
> blockdev-add fails if an invalid node name is given, so we should
> document what a valid node name even is.
>
> Reported-by: Cong Li <coli@redhat.com>
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>

Reviewed-by: Alberto Garcia <berto@igalia.com>

Berto
diff mbox series

Patch

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 62a92fa4f4..fe565ebfaf 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -3563,6 +3563,9 @@ 
 # @driver:        block driver name
 # @node-name:     the node name of the new node (Since 2.0).
 #                 This option is required on the top level of blockdev-add.
+#                 Valid node names start with an alphabetic character and may
+#                 contain only alphanumeric characters, '-', '.' and '_'. Their
+#                 maximum length is 31 characters.
 # @discard:       discard-related options (default: ignore)
 # @cache:         cache-related options
 # @read-only:     whether the block device should be read-only (default: false).