On 26/02/24 16:44, Andrew Cooper wrote:
On 02/02/2024 3:16 pm, Simone Ballarin wrote:
From: Maria Celeste Cesario <[email protected]>

Function and macro properties contained in ECLAIR/call_properties.ecl are of
general interest: this patch moves these annotations in a generaric JSON file
in docs. In this way, they can be exploited for other purposes (i.e. 
documentation,
other tools).

Add rst file containing explanation on how to update 
function_macro_properties.json.
Add script to convert the JSON file in ECL configurations.
Remove ECLAIR/call_properties.ecl: the file is now automatically generated from
the JSON file.

Signed-off-by: Maria Celeste Cesario  <[email protected]>
Signed-off-by: Simone Ballarin  <[email protected]>

---
Changes in v4:
- add missing script for converting the JSON file in ECL configurations;
- improve commit message;
- remove call_properties.ecs.
---
  .../eclair_analysis/ECLAIR/analysis.ecl       |   1 +
  .../ECLAIR/call_properties.ecl                | 128 ---
  automation/eclair_analysis/prepare.sh         |   2 +
  automation/eclair_analysis/propertyparser.py  |  37 +
  docs/function_macro_properties.json           | 841 ++++++++++++++++++
  docs/function_macro_properties.rst            |  58 ++
  6 files changed, 939 insertions(+), 128 deletions(-)
  delete mode 100644 automation/eclair_analysis/ECLAIR/call_properties.ecl
  create mode 100644 automation/eclair_analysis/propertyparser.py
  create mode 100644 docs/function_macro_properties.json
  create mode 100644 docs/function_macro_properties.rst

This breaks the Sphinx build.

checking consistency...
/local/xen.git/docs/function_macro_properties.rst: WARNING: document
isn't included in any toctree

Also, the top level of docs really isn't an appropriate place to put
it.  Everything else is in docs/misra/.

When you've moved the files, you'll need to edit docs/misra/index.rst to
fix the build.

~Andrew


I've submitted a new patch moving these files in docs/misra
and adding the rst file in the docs/misra/index.rst's toctree.

--
Simone Ballarin, M.Sc.

Field Application Engineer, BUGSENG (https://bugseng.com)


Reply via email to