[Accel-config] Re: [PATCH] accel-config: Update doc with a json file format requirement

Dave Jiang <dave.jiang at intel.com>
Newsgroups dev.linux.lists.accel-config
Message-ID <[email protected]>
On 6/28/2021 12:55 PM, ramesh.thomas(a)intel.com wrote:
> From: Ramesh Thomas <ramesh.thomas(a)intel.com>
>
> Config files use json format which uses keys for each object. Mention in
> manpages that the "dev" property is used as the key and must be the firt
> entry in each object block.
>
> Signed-off-by: Ramesh Thomas <ramesh.thomas(a)intel.com>

Reviewed-by: Dave Jiang <dave.jiang(a)intel.com>

Should put giant warning about not hand craft json files and let the 
tool do it.

> ---
>   Documentation/accfg/accel-config-load-config.txt | 3 +++
>   1 file changed, 3 insertions(+)
>
> diff --git a/Documentation/accfg/accel-config-load-config.txt b/Documentation/accfg/accel-config-load-config.txt
> index 23867ff..53ea01d 100644
> --- a/Documentation/accfg/accel-config-load-config.txt
> +++ b/Documentation/accfg/accel-config-load-config.txt
> @@ -21,6 +21,9 @@ like, but it should not be used directly given the variance of each system. The
>   user should create a proper config file according to the format of sample file
>   and use "-c" option to point to the config file.
>   
> +The "dev" property is used as the key for each json object and must be the
> +first entry in each object block.
> +
>   EXAMPLE
>   -------
>   ----
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.