Skip to contentSkip to conversation

accel-config: Update doc with a json file format requirement

PATCH In review ramesh.thomas at intel.com 2 participants 2 messages Jun 28, 2021 Documentation

lore
Share & tools
lore

ramesh.thomas at intel.com

#0 lore raw

PATCH 1/1 accel-config: Update doc with a json file format requirement

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>
---
 Documentation/accfg/accel-config-load-config.txt | 3 +++
 1 file changed, 3 insertions(+)
Documentation/accfg/accel-config-load-config.txt +3 -0
index 23867ff..53ea01d 100644
@@ -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
 -------
 ----
Signature · 1 line
2.26.3
Reviewed-by on v1 1/1
#1 lore raw
Quoted 7 lines · ramesh.thomas(a)intel.com

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.

Quoted 18 lines
---
  Documentation/accfg/accel-config-load-config.txt | 3 +++
  1 file changed, 3 insertions(+)
Documentation/accfg/accel-config-load-config.txt +3 -0
index 23867ff..53ea01d 100644
@@ -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
  -------
  ----