[PATCH 0/2] misc: Rename included template headers using '.inc' suffix

[PATCH 0/2] misc: Rename included template headers using '.inc' suffix

[Philippe Mathieu-Daudé]

Follow 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.

Philippe Mathieu-Daudé (2):
  target/hexagon: Rename macros.inc -> macros.h.inc
  tests/bench: Rename test_akcipher_keys.inc -> test_akcipher_keys.c.inc

 target/hexagon/idef-parser/README.rst                         | 4 ++--
 target/hexagon/idef-parser/{macros.inc => macros.h.inc}       | 0
 tests/bench/benchmark-crypto-akcipher.c                       | 2 +-
 .../{test_akcipher_keys.inc => test_akcipher_keys.c.inc}      | 0
 target/hexagon/gen_idef_parser_funcs.py                       | 2 +-
 target/hexagon/meson.build                                    | 2 +-
 6 files changed, 5 insertions(+), 5 deletions(-)
 rename target/hexagon/idef-parser/{macros.inc => macros.h.inc} (100%)
 rename tests/bench/{test_akcipher_keys.inc => test_akcipher_keys.c.inc} (100%)

-- 
2.45.2

[PATCH 1/2] target/hexagon: Rename macros.inc -> macros.h.inc

[Philippe Mathieu-Daudé]

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%)

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@'],
     )
 
-- 
2.45.2

Re: [PATCH 1/2] target/hexagon: Rename macros.inc -> macros.h.inc

[Brian Cain]

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@'],
>       )
>   

Re: [PATCH 1/2] target/hexagon: Rename macros.inc -> macros.h.inc

[Anton Johansson via]

On 10/09/24, 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>
> ---
>  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%)
> 

Reviewed-by: Anton Johansson <anjo@rev.ng>

[PATCH 2/2] tests/bench: Rename test_akcipher_keys.inc -> test_akcipher_keys.c.inc

[Philippe Mathieu-Daudé]

Since commit 139c1837db ("meson: rename included C source files
to .c.inc"), QEMU standard procedure for included C files is to
use *.c.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.

Rename "test_akcipher_keys.inc" as "test_akcipher_keys.c.inc".

Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
 tests/bench/benchmark-crypto-akcipher.c                         | 2 +-
 .../bench/{test_akcipher_keys.inc => test_akcipher_keys.c.inc}  | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename tests/bench/{test_akcipher_keys.inc => test_akcipher_keys.c.inc} (100%)

diff --git a/tests/bench/benchmark-crypto-akcipher.c b/tests/bench/benchmark-crypto-akcipher.c
index 5e68cb0a1c..fb88106a0c 100644
--- a/tests/bench/benchmark-crypto-akcipher.c
+++ b/tests/bench/benchmark-crypto-akcipher.c
@@ -16,7 +16,7 @@
 #include "crypto/akcipher.h"
 #include "standard-headers/linux/virtio_crypto.h"
 
-#include "test_akcipher_keys.inc"
+#include "test_akcipher_keys.c.inc"
 
 static QCryptoAkCipher *create_rsa_akcipher(const uint8_t *priv_key,
                                             size_t keylen,
diff --git a/tests/bench/test_akcipher_keys.inc b/tests/bench/test_akcipher_keys.c.inc
similarity index 100%
rename from tests/bench/test_akcipher_keys.inc
rename to tests/bench/test_akcipher_keys.c.inc
-- 
2.45.2

Re: [PATCH 0/2] misc: Rename included template headers using '.inc' suffix

[Richard Henderson]

On 9/10/24 04:28, Philippe Mathieu-Daudé wrote:
> Philippe Mathieu-Daudé (2):
>    target/hexagon: Rename macros.inc -> macros.h.inc
>    tests/bench: Rename test_akcipher_keys.inc -> test_akcipher_keys.c.inc

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>


r~

Re: [PATCH 0/2] misc: Rename included template headers using '.inc' suffix

[Michael Tokarev]

On 10.09.2024 14:28, Philippe Mathieu-Daudé wrote:
> Follow 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.
> 
> Philippe Mathieu-Daudé (2):
>    target/hexagon: Rename macros.inc -> macros.h.inc
>    tests/bench: Rename test_akcipher_keys.inc -> test_akcipher_keys.c.inc

Picked up for the trivial-patches tree, thanks!

/mjt