Re: [PATCH 1/2] Documentation: bootconfig: Add EBNF definiton of bootconfig

[Masami Hiramatsu (Google) <mhiramat@kernel.org>]

On Sat, 14 Mar 2026 18:06:40 +0900
"Masami Hiramatsu (Google)" <mhiramat@kernel.org> wrote:

> From: Masami Hiramatsu (Google) <mhiramat@kernel.org>
> 
> Add the EBNF definition to Documentation/admin-guide/bootconfig.rst
> to formally define the bootconfig syntax.
> 

Wait, I rethink it may be better to be a separated section
so that it can be referred easily.
Let me update it.

Thanks,

> Signed-off-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
> ---
>  Documentation/admin-guide/bootconfig.rst |   15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/Documentation/admin-guide/bootconfig.rst b/Documentation/admin-guide/bootconfig.rst
> index f712758472d5..5c5f736ca982 100644
> --- a/Documentation/admin-guide/bootconfig.rst
> +++ b/Documentation/admin-guide/bootconfig.rst
> @@ -22,6 +22,21 @@ The boot config syntax is a simple structured key-value. Each key consists
>  of dot-connected-words, and key and value are connected by ``=``. The value
>  string has to be terminated by the following delimiters described below.
>  
> +The syntax is defined in EBNF as follows::
> +
> +  Config = { Statement }
> +  Statement = [ Key [ Assignment | Block ] | Comment ] ( "\n" | ";" )
> +  Assignment = ( "=" | "+=" | ":=" ) ValueList
> +  ValueList = [ Value { "," [ { ( Comment | "\n" ) } ] Value } ]
> +  Block = "{" { Statement } "}"
> +  Key = Word { "." Word }
> +  Word = [a-zA-Z0-9_-]+
> +  Value = QuotedValue | UnquotedValue
> +  QuotedValue = "\"" { any_character_except_double_quote } "\""
> +              | "'" { any_character_except_single_quote } "'"
> +  UnquotedValue = { any_printable_character_except_delimiters }
> +  Comment = "#" { any_character_except_newline }
> +
>  Each key word must contain only alphabets, numbers, dash (``-``) or underscore
>  (``_``). And each value only contains printable characters or spaces except
>  for delimiters such as semi-colon (``;``), new-line (``\n``), comma (``,``),
> 


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>