Skip to content
  • Brad King's avatar
    Format include directive blocks and ordering with clang-format · e1c77472
    Brad King authored
    
    
    Sort include directives within each block (separated by a blank line) in
    lexicographic order (except to prioritize `sys/types.h` first).  First
    run `clang-format` with the config file:
    
        ---
        SortIncludes: false
        ...
    
    Commit the result temporarily.  Then run `clang-format` again with:
    
        ---
        SortIncludes: true
        IncludeCategories:
          - Regex:    'sys/types.h'
            Priority: -1
        ...
    
    Commit the result temporarily.  Start a new branch and cherry-pick the
    second commit.  Manually resolve conflicts to preserve indentation of
    re-ordered includes.  This cleans up the include ordering without
    changing any other style.
    
    Use the following command to run `clang-format`:
    
        $ git ls-files -z -- \
            '*.c' '*.cc' '*.cpp' '*.cxx' '*.h' '*.hh' '*.hpp' '*.hxx' |
          egrep -z -v '(Lexer|Parser|ParserHelper)\.' |
          egrep -z -v '^Source/cm_sha2' |
          egrep -z -v '^Source/(kwsys|CursesDialog/form)/' |
          egrep -z -v '^Utilities/(KW|cm).*/' |
          egrep -z -v '^Tests/Module/GenerateExportHeader' |
          egrep -z -v '^Tests/RunCMake/CommandLine/cmake_depends/test_UTF-16LE.h' |
          xargs -0 clang-format -i
    
    This selects source files that do not come from a third-party.
    
    Inspired-by: default avatarDaniel Pfeifer <daniel@pfeifer-mail.de>
    e1c77472