| Message ID | 20240910112833.27594-2-philmd@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | misc: Rename included template headers using '.inc' suffix | expand |
On 9/10/2024 6:28 AM, Philippe Mathieu-Daudé wrote: > Since commits 139c1837db ("meson: rename included C source files > to .c.inc") and 0979ed017f ("meson: rename .inc.h files to .h.inc"), > EMU standard procedure for included header files is to use *.h.inc. > > Besides, since commit 6a0057aa22 ("docs/devel: make a statement > about includes") this is documented in the Coding Style: > > If you do use template header files they should be named with > the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are > being included for expansion. > > Therefore rename "macros.inc" as "macros.h.inc". > > Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> > --- Reviewed-by: Brian Cain <bcain@quicinc.com> > target/hexagon/idef-parser/README.rst | 4 ++-- > target/hexagon/idef-parser/{macros.inc => macros.h.inc} | 0 > target/hexagon/gen_idef_parser_funcs.py | 2 +- > target/hexagon/meson.build | 2 +- > 4 files changed, 4 insertions(+), 4 deletions(-) > rename target/hexagon/idef-parser/{macros.inc => macros.h.inc} (100%) > > diff --git a/target/hexagon/idef-parser/README.rst b/target/hexagon/idef-parser/README.rst > index d0aa34309b..7199177ee3 100644 > --- a/target/hexagon/idef-parser/README.rst > +++ b/target/hexagon/idef-parser/README.rst > @@ -138,7 +138,7 @@ we obtain the pseudo code > with macros such as ``fJUMPR`` intact. > > The second step is to expand macros into a form suitable for our parser. > -These macros are defined in ``idef-parser/macros.inc`` and the step is > +These macros are defined in ``idef-parser/macros.h.inc`` and the step is > carried out by the ``prepare`` script which runs the C preprocessor on > ``idef_parser_input.h.inc`` to produce > ``idef_parser_input.preprocessed.h.inc``. > @@ -266,7 +266,7 @@ in plain C is defined as > #define fABS(A) (((A) < 0) ? (-(A)) : (A)) > > and returns the absolute value of the argument ``A``. This macro is not included > -in ``idef-parser/macros.inc`` and as such is not expanded and kept as a "call" > +in ``idef-parser/macros.h.inc`` and as such is not expanded and kept as a "call" > ``fABS(...)``. Reason being, that ``fABS`` is easier to match and map to > ``tcg_gen_abs_<width>``, compared to the full ternary expression above. Loads of > macros in ``macros.h`` are kept unexpanded to aid in parsing, as seen in the > diff --git a/target/hexagon/idef-parser/macros.inc b/target/hexagon/idef-parser/macros.h.inc > similarity index 100% > rename from target/hexagon/idef-parser/macros.inc > rename to target/hexagon/idef-parser/macros.h.inc > diff --git a/target/hexagon/gen_idef_parser_funcs.py b/target/hexagon/gen_idef_parser_funcs.py > index eb494abba8..72f11c68ca 100644 > --- a/target/hexagon/gen_idef_parser_funcs.py > +++ b/target/hexagon/gen_idef_parser_funcs.py > @@ -50,7 +50,7 @@ def main(): > tagimms = hex_common.get_tagimms() > > with open(sys.argv[-1], "w") as f: > - f.write('#include "macros.inc"\n\n') > + f.write('#include "macros.h.inc"\n\n') > > for tag in hex_common.tags: > ## Skip the priv instructions > diff --git a/target/hexagon/meson.build b/target/hexagon/meson.build > index 9ea1f4fc59..f1723778a6 100644 > --- a/target/hexagon/meson.build > +++ b/target/hexagon/meson.build > @@ -284,7 +284,7 @@ if idef_parser_enabled and 'hexagon-linux-user' in target_dirs > 'idef_parser_input.preprocessed.h.inc', > output: 'idef_parser_input.preprocessed.h.inc', > input: idef_parser_input_generated, > - depend_files: [idef_parser_dir / 'macros.inc'], > + depend_files: [idef_parser_dir / 'macros.h.inc'], > command: [idef_parser_dir / 'prepare', '@INPUT@', '-I' + idef_parser_dir, '-o', '@OUTPUT@'], > ) >
diff --git a/target/hexagon/idef-parser/README.rst b/target/hexagon/idef-parser/README.rst index d0aa34309b..7199177ee3 100644 --- a/target/hexagon/idef-parser/README.rst +++ b/target/hexagon/idef-parser/README.rst @@ -138,7 +138,7 @@ we obtain the pseudo code with macros such as ``fJUMPR`` intact. The second step is to expand macros into a form suitable for our parser. -These macros are defined in ``idef-parser/macros.inc`` and the step is +These macros are defined in ``idef-parser/macros.h.inc`` and the step is carried out by the ``prepare`` script which runs the C preprocessor on ``idef_parser_input.h.inc`` to produce ``idef_parser_input.preprocessed.h.inc``. @@ -266,7 +266,7 @@ in plain C is defined as #define fABS(A) (((A) < 0) ? (-(A)) : (A)) and returns the absolute value of the argument ``A``. This macro is not included -in ``idef-parser/macros.inc`` and as such is not expanded and kept as a "call" +in ``idef-parser/macros.h.inc`` and as such is not expanded and kept as a "call" ``fABS(...)``. Reason being, that ``fABS`` is easier to match and map to ``tcg_gen_abs_<width>``, compared to the full ternary expression above. Loads of macros in ``macros.h`` are kept unexpanded to aid in parsing, as seen in the diff --git a/target/hexagon/idef-parser/macros.inc b/target/hexagon/idef-parser/macros.h.inc similarity index 100% rename from target/hexagon/idef-parser/macros.inc rename to target/hexagon/idef-parser/macros.h.inc diff --git a/target/hexagon/gen_idef_parser_funcs.py b/target/hexagon/gen_idef_parser_funcs.py index eb494abba8..72f11c68ca 100644 --- a/target/hexagon/gen_idef_parser_funcs.py +++ b/target/hexagon/gen_idef_parser_funcs.py @@ -50,7 +50,7 @@ def main(): tagimms = hex_common.get_tagimms() with open(sys.argv[-1], "w") as f: - f.write('#include "macros.inc"\n\n') + f.write('#include "macros.h.inc"\n\n') for tag in hex_common.tags: ## Skip the priv instructions diff --git a/target/hexagon/meson.build b/target/hexagon/meson.build index 9ea1f4fc59..f1723778a6 100644 --- a/target/hexagon/meson.build +++ b/target/hexagon/meson.build @@ -284,7 +284,7 @@ if idef_parser_enabled and 'hexagon-linux-user' in target_dirs 'idef_parser_input.preprocessed.h.inc', output: 'idef_parser_input.preprocessed.h.inc', input: idef_parser_input_generated, - depend_files: [idef_parser_dir / 'macros.inc'], + depend_files: [idef_parser_dir / 'macros.h.inc'], command: [idef_parser_dir / 'prepare', '@INPUT@', '-I' + idef_parser_dir, '-o', '@OUTPUT@'], )
Since commits 139c1837db ("meson: rename included C source files to .c.inc") and 0979ed017f ("meson: rename .inc.h files to .h.inc"), EMU standard procedure for included header files is to use *.h.inc. Besides, since commit 6a0057aa22 ("docs/devel: make a statement about includes") this is documented in the Coding Style: If you do use template header files they should be named with the ``.c.inc`` or ``.h.inc`` suffix to make it clear they are being included for expansion. Therefore rename "macros.inc" as "macros.h.inc". Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> --- target/hexagon/idef-parser/README.rst | 4 ++-- target/hexagon/idef-parser/{macros.inc => macros.h.inc} | 0 target/hexagon/gen_idef_parser_funcs.py | 2 +- target/hexagon/meson.build | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) rename target/hexagon/idef-parser/{macros.inc => macros.h.inc} (100%)