mbox series

[0/5] misc: Enforce .[ch].inc extension for re-included .c/.h files

Message ID 20230606141252.95032-1-philmd@linaro.org
Headers show
Series misc: Enforce .[ch].inc extension for re-included .c/.h files | expand

Message

Philippe Mathieu-Daudé June 6, 2023, 2:12 p.m. UTC 
Follow the convention to use the .inc extension for .c/.h files
re-included, as docummented in Coding Style since commit 6a0057aa22:

    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.

Most of the codebase already uses this extension:

  $ git ls-files | fgrep .inc | wc -l
       155

Rename some files left over.

Philippe Mathieu-Daudé (5):
  bsd-user: Rename elfcore.c -> elfcore.c.inc
  target/arm: Rename helper template headers as '.h.inc'
  target/i386: Rename helper template headers as '.h.inc'
  target: Rename per-target 'helper.h' -> 'helper.h.inc'
  tests/tcg/aarch64: Rename bti-crt.inc.c -> bti-crt.c.inc

 docs/devel/tcg-ops.rst                                    | 2 +-
 include/exec/helper-gen.h                                 | 2 +-
 include/exec/helper-proto.h                               | 2 +-
 target/alpha/{helper.h => helper.h.inc}                   | 0
 target/arm/{helper.h => helper.h.inc}                     | 8 ++++----
 target/arm/tcg/{helper-a64.h => helper-a64.h.inc}         | 0
 target/arm/tcg/{helper-mve.h => helper-mve.h.inc}         | 0
 target/arm/tcg/{helper-sme.h => helper-sme.h.inc}         | 0
 target/arm/tcg/{helper-sve.h => helper-sve.h.inc}         | 0
 target/avr/{helper.h => helper.h.inc}                     | 0
 target/cris/{helper.h => helper.h.inc}                    | 0
 target/hexagon/{helper.h => helper.h.inc}                 | 0
 target/hppa/{helper.h => helper.h.inc}                    | 0
 target/i386/{helper.h => helper.h.inc}                    | 6 +++---
 target/i386/{ops_sse_header.h => ops_sse_header.h.inc}    | 0
 ...hift_helper_template.h => shift_helper_template.h.inc} | 0
 .../{cc_helper_template.h => cc_helper_template.h.inc}    | 0
 target/loongarch/{helper.h => helper.h.inc}               | 0
 target/m68k/{helper.h => helper.h.inc}                    | 0
 target/microblaze/{helper.h => helper.h.inc}              | 0
 target/mips/{helper.h => helper.h.inc}                    | 0
 target/nios2/{helper.h => helper.h.inc}                   | 0
 target/openrisc/{helper.h => helper.h.inc}                | 0
 target/ppc/{helper.h => helper.h.inc}                     | 0
 target/riscv/{helper.h => helper.h.inc}                   | 0
 target/rx/{helper.h => helper.h.inc}                      | 0
 target/s390x/{helper.h => helper.h.inc}                   | 0
 target/sh4/{helper.h => helper.h.inc}                     | 0
 target/sparc/{helper.h => helper.h.inc}                   | 0
 target/tricore/{helper.h => helper.h.inc}                 | 0
 target/xtensa/{helper.h => helper.h.inc}                  | 0
 bsd-user/elfload.c                                        | 2 +-
 target/alpha/translate.c                                  | 2 +-
 target/arm/machine.c                                      | 2 +-
 target/arm/tcg/translate.c                                | 2 +-
 target/avr/translate.c                                    | 2 +-
 target/cris/translate.c                                   | 2 +-
 target/hexagon/translate.c                                | 2 +-
 target/hppa/translate.c                                   | 2 +-
 target/i386/tcg/cc_helper.c                               | 8 ++++----
 target/i386/tcg/int_helper.c                              | 8 ++++----
 target/i386/tcg/translate.c                               | 2 +-
 target/loongarch/translate.c                              | 2 +-
 target/m68k/translate.c                                   | 2 +-
 target/microblaze/translate.c                             | 2 +-
 target/mips/tcg/translate.c                               | 2 +-
 target/nios2/translate.c                                  | 2 +-
 target/openrisc/translate.c                               | 2 +-
 target/ppc/translate.c                                    | 2 +-
 target/riscv/translate.c                                  | 2 +-
 target/rx/translate.c                                     | 2 +-
 target/s390x/tcg/translate.c                              | 2 +-
 target/sh4/translate.c                                    | 2 +-
 target/sparc/translate.c                                  | 2 +-
 target/tricore/translate.c                                | 2 +-
 target/xtensa/translate.c                                 | 2 +-
 tests/tcg/aarch64/bti-1.c                                 | 2 +-
 tests/tcg/aarch64/bti-3.c                                 | 2 +-
 bsd-user/{elfcore.c => elfcore.c.inc}                     | 0
 tests/tcg/aarch64/{bti-crt.inc.c => bti-crt.c.inc}        | 0
 60 files changed, 43 insertions(+), 43 deletions(-)
 rename target/alpha/{helper.h => helper.h.inc} (100%)
 rename target/arm/{helper.h => helper.h.inc} (99%)
 rename target/arm/tcg/{helper-a64.h => helper-a64.h.inc} (100%)
 rename target/arm/tcg/{helper-mve.h => helper-mve.h.inc} (100%)
 rename target/arm/tcg/{helper-sme.h => helper-sme.h.inc} (100%)
 rename target/arm/tcg/{helper-sve.h => helper-sve.h.inc} (100%)
 rename target/avr/{helper.h => helper.h.inc} (100%)
 rename target/cris/{helper.h => helper.h.inc} (100%)
 rename target/hexagon/{helper.h => helper.h.inc} (100%)
 rename target/hppa/{helper.h => helper.h.inc} (100%)
 rename target/i386/{helper.h => helper.h.inc} (98%)
 rename target/i386/{ops_sse_header.h => ops_sse_header.h.inc} (100%)
 rename target/i386/{shift_helper_template.h => shift_helper_template.h.inc} (100%)
 rename target/i386/tcg/{cc_helper_template.h => cc_helper_template.h.inc} (100%)
 rename target/loongarch/{helper.h => helper.h.inc} (100%)
 rename target/m68k/{helper.h => helper.h.inc} (100%)
 rename target/microblaze/{helper.h => helper.h.inc} (100%)
 rename target/mips/{helper.h => helper.h.inc} (100%)
 rename target/nios2/{helper.h => helper.h.inc} (100%)
 rename target/openrisc/{helper.h => helper.h.inc} (100%)
 rename target/ppc/{helper.h => helper.h.inc} (100%)
 rename target/riscv/{helper.h => helper.h.inc} (100%)
 rename target/rx/{helper.h => helper.h.inc} (100%)
 rename target/s390x/{helper.h => helper.h.inc} (100%)
 rename target/sh4/{helper.h => helper.h.inc} (100%)
 rename target/sparc/{helper.h => helper.h.inc} (100%)
 rename target/tricore/{helper.h => helper.h.inc} (100%)
 rename target/xtensa/{helper.h => helper.h.inc} (100%)
 rename bsd-user/{elfcore.c => elfcore.c.inc} (100%)
 rename tests/tcg/aarch64/{bti-crt.inc.c => bti-crt.c.inc} (100%)

Comments

Alex Bennée June 6, 2023, 5:02 p.m. UTC | #1 
Philippe Mathieu-Daudé <philmd@linaro.org> writes:

> Follow the convention to use the .inc extension for .c/.h files
> re-included, as docummented in Coding Style since commit 6a0057aa22:
>
>     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.
>
> Most of the codebase already uses this extension:
>
>   $ git ls-files | fgrep .inc | wc -l
>        155

Ahh prescient as I've just added this hack to the loc tool I'm using:

  modified   src/lib.rs
  @@ -338,7 +338,7 @@ pub fn lang_from_ext(filepath: &str) -> Lang {
           "at" => AmbientTalk,
           "awk" => Awk,
           "bat" | "btm" | "cmd" => Batch,
  -        "c" | "ec" | "pgc" => C,
  +        "c" | "ec" | "pgc" | "inc" => C,
           "cc" | "cpp" | "cxx" | "c++" | "pcc" => Cpp,
           "cfc" => ColdFusionScript,
           "cmake" => CMake,

while gathering loc stats for the project.