History log of /openbmc/entity-manager/CONFIG_FORMAT.md (Results 1 – 9 of 9)
Revision Date Author Comments
# edc46347 06-Jan-2025 Alexander Hansen <alexander.hansen@9elements.com>

meson: generate configurations list

To avoid manually listing all the configuration files, use a script to
make a list of them.

There is a tradeoff when running a command to get the filenames, as i

meson: generate configurations list

To avoid manually listing all the configuration files, use a script to
make a list of them.

There is a tradeoff when running a command to get the filenames, as it
may not regenerate when file is added/removed [1].

So the list can still be kept as source, but generated in its own
separate file.

References:
[1] https://mesonbuild.com/FAQ.html#but-i-really-want-to-use-wildcards

Change-Id: I760486bafe94fce6485dfb7627946d0a77fdd322
Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>

show more ...


# 0f3a4d99 04-Dec-2023 Potin Lai <potin.lai@quantatw.com>

Support C-style comments for configuration JSON parsing

1. Add and set ignore_comment to true to all nlohmann::json::parse().
2. Add remove_c_comments() in `validate_configs.py` to remove C-style

Support C-style comments for configuration JSON parsing

1. Add and set ignore_comment to true to all nlohmann::json::parse().
2. Add remove_c_comments() in `validate_configs.py` to remove C-style
comments before loading.
3. Attempt to reformat comments in the `autojson.py` taking liberal
short-cuts which are documented in the script.

Supported comment examples:

- Single-line style comments
```
{
// Single-line style comment (new line)
"Key": "Value" // Single-line comment (end of content)
}
```

- Multi-line style comments
```
{
/* Multi-line style comment */
/*
* Multi-line style comments
*/
}
```

Tested on harma system with manual applied patch below, which contains
a c-style comment in harma-pttv.json file.
Link: https://gerrit.openbmc.org/c/openbmc/entity-manager/+/67469/25

- scripts/autojson.py
Run autojson.py on harma-pttv.json, the output as same as original file.

- scripts/validate_configs.py
Run validate_configs.py passed.

- EntityManager service
EntityManager service loads and probes harma-pttv.json successfully.
```
root@harma:~# busctl introspect xyz.openbmc_project.EntityManager \
> /xyz/openbmc_project/inventory/system/board/Harma_PTTV \
> xyz.openbmc_project.Inventory.Item.Board
NAME TYPE SIGNATURE RESULT/VALUE FLAGS
.Name property s "Harma PTTV" emits-change
.Probe property s "xyz.openbmc_project.FruDevice({\'BOA... emits-change
.Type property s "Board" emits-change
```

Signed-off-by: Potin Lai <potin.lai@quantatw.com>
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ib235f2aa6a724615dc4c8184577f57abda8e17a6

show more ...


# c76e53a3 28-Nov-2023 Chris Cain <cjcain@us.ibm.com>

Update README link in CONFIG_FORMAT.md

Link to README was referencing .schema file which does not exist.
Updated to use the .md file.

Change-Id: If79c08310e0c1115909d2e2081f3bc1721c1bad0
Signed-off

Update README link in CONFIG_FORMAT.md

Link to README was referencing .schema file which does not exist.
Updated to use the .md file.

Change-Id: If79c08310e0c1115909d2e2081f3bc1721c1bad0
Signed-off-by: Chris Cain <cjcain@us.ibm.com>

show more ...


# ec1137d5 07-Dec-2022 Patrick Williams <patrick@stwcx.xyz>

markdownlint: fix all warnings

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I2a77806e59860015339b90957e2226eecd6b5423


# fa8ee87e 07-Dec-2022 Patrick Williams <patrick@stwcx.xyz>

format: reformat with latest openbmc-build-scripts

Run all the latest formatters from openbmc-build-scripts. Disable
prettier on the configurations subdirectory because these are
script-formatted a

format: reformat with latest openbmc-build-scripts

Run all the latest formatters from openbmc-build-scripts. Disable
prettier on the configurations subdirectory because these are
script-formatted already with the repo-local `format-code` extension.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ifa4f2ec6688d60fde2a5f42efc96b6046e9be642

show more ...


# 394ea2b4 10-May-2022 Zev Weiss <zev@bewilderbeest.net>

configurations: Avoid spaces in file names

Having spaces in file names makes many common shell operations
unnecessarily awkward, so replace them all with underscores instead.

Signed-off-by: Zev Wei

configurations: Avoid spaces in file names

Having spaces in file names makes many common shell operations
unnecessarily awkward, so replace them all with underscores instead.

Signed-off-by: Zev Weiss <zev@bewilderbeest.net>
Change-Id: I4d3d063ee6470702b08160129fb0fe829aaf93a6

show more ...


# 797632e2 21-Feb-2022 Glukhov Mikhail <mikl@greenfil.ru>

Fixed quote

Signed-off-by: Glukhov Mikhail <mikl@greenfil.ru>
Change-Id: I0a6a8e2e323cac09fa62f8ce7b7340170c99cf42


# 21608383 05-Oct-2020 Ed Tanous <ed@tanous.net>

update config file documentation

Entity manager config file readme needs some intent documented, as well
as some specifics, on top of the examples.

Tested:
Ran through spell checker, and launched i

update config file documentation

Entity manager config file readme needs some intent documented, as well
as some specifics, on top of the examples.

Tested:
Ran through spell checker, and launched in markdown browser. Didn't
observe any obvious problems.

Change-Id: Ibc5d5b48bc386baf2b98a0351732f4f61e322692

show more ...


# dfa14b5f 31-Aug-2020 Ed Tanous <ed@tanous.net>

Move config format to its own file

The existing readme seems like it's more of an examples section anyway.
This commit mostly exists just to make the git history clean and clear
the path. The next

Move config format to its own file

The existing readme seems like it's more of an examples section anyway.
This commit mostly exists just to make the git history clean and clear
the path. The next commit in this series is more important.

Signed-off-by: Ed Tanous <ed@tanous.net>
Change-Id: Ia5e36e7f556abd0dd25eb43e4883347f4624403c

show more ...