| Message ID | ee28804796625835688069997a06b719d0739b9b.1709048153.git.simone.ballarin@bugseng.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [XEN] docs: Move function and macro properties in docs/misra | expand |
On 27/02/2024 3:36 pm, Simone Ballarin wrote: > The list of function/macro properties is not MISRA-specific documentation. > Their addition was directly motivated to address MISRA findings and they > are not used elsewhere. For this reason, this patch moves these properties > in docs/misra. > > This patch also fixes a Sphinx warning caused by the missing inclusion > of the rst file in the toctree. > > Reported-by: Andrew Cooper <andrew.cooper3@citrix.com> > Fixes: f4519ee8 ("eclair: move function and macro properties outside ECLAIR") > Signed-off-by: Simone Ballarin <simone.ballarin@bugseng.com> Acked-by: Andrew Cooper <andrew.cooper3@citrix.com> Thanks for fixing this. ~Andrew
diff --git a/automation/eclair_analysis/propertyparser.py b/automation/eclair_analysis/propertyparser.py index 0d02f505a6..5059a68fec 100644 --- a/automation/eclair_analysis/propertyparser.py +++ b/automation/eclair_analysis/propertyparser.py @@ -2,7 +2,7 @@ import json import os script_dir = os.path.dirname(__file__) -properties_path = os.path.join(script_dir, "../../docs/function_macro_properties.json") +properties_path = os.path.join(script_dir, "../../docs/misra/function-macro-properties.json") output_path = os.path.join(script_dir, "ECLAIR/call_properties.ecl") with open(properties_path) as fp: diff --git a/docs/function_macro_properties.json b/docs/misra/function-macro-properties.json similarity index 100% rename from docs/function_macro_properties.json rename to docs/misra/function-macro-properties.json diff --git a/docs/function_macro_properties.rst b/docs/misra/function-macro-properties.rst similarity index 100% rename from docs/function_macro_properties.rst rename to docs/misra/function-macro-properties.rst diff --git a/docs/misra/index.rst b/docs/misra/index.rst index 5068ee5aef..bde9d9cffb 100644 --- a/docs/misra/index.rst +++ b/docs/misra/index.rst @@ -16,3 +16,4 @@ Xen hypervisor code and related documents. documenting-violations exclude-list xen-static-analysis + function-macro-properties
The list of function/macro properties is not MISRA-specific documentation. Their addition was directly motivated to address MISRA findings and they are not used elsewhere. For this reason, this patch moves these properties in docs/misra. This patch also fixes a Sphinx warning caused by the missing inclusion of the rst file in the toctree. Reported-by: Andrew Cooper <andrew.cooper3@citrix.com> Fixes: f4519ee8 ("eclair: move function and macro properties outside ECLAIR") Signed-off-by: Simone Ballarin <simone.ballarin@bugseng.com> --- automation/eclair_analysis/propertyparser.py | 2 +- .../function-macro-properties.json} | 0 .../function-macro-properties.rst} | 0 docs/misra/index.rst | 1 + 4 files changed, 2 insertions(+), 1 deletion(-) rename docs/{function_macro_properties.json => misra/function-macro-properties.json} (100%) rename docs/{function_macro_properties.rst => misra/function-macro-properties.rst} (100%)