solenv/clang-format/README

   1 Style enforcing code.
   2
   3 == How to reproduce the binaries at <https://dev-www.libreoffice.org/bin/> ==
   4
   5 - Linux:
   6
   7   - Built from source on openSUSE Leap 42.3
   8   - get <http://releases.llvm.org/5.0.0/llvm-5.0.0.src.tar.xz>
   9   - get <http://releases.llvm.org/5.0.0/cfe-5.0.0.src.tar.xz>  and extract this as tools/clang/ in the LLVM source code
  10   - mkdir workdir; cd workdir; cmake -G 'Unix Makefiles' -DCMAKE_INSTALL_PREFIX=$PWD/../instdir -DCMAKE_BUILD_TYPE=Release -DLLVM_BUILD_STATIC=true ..; make -j8 clang-format
  11   - this produces a binary that is statically linked
  12
  13 - macOS:
  14
  15   - <http://releases.llvm.org/5.0.0/clang+llvm-5.0.0-x86_64-apple-darwin.tar.xz> provides a portable binary already
  16
  17 - Windows:
  18
  19   - <http://releases.llvm.org/5.0.0/LLVM-5.0.0-win32.exe> provides a portable binary already
  20
  21 == Directory contents ==
  22
  23 - blacklist: list of existing files not to be formatted:
  24
  25   - if you rename a file mentioned in this list, please update the entry (and
  26     keep the file sorted)
  27
  28 - check-last-commit: this is used during gerrit / jenkins verification
  29
  30 - ClangFormat.pm: shared code between the git hook and these scripts
  31
  32 - generate-style-blacklist: was used to generate `blacklist`
  33
  34 - reformat-formatted-files: run this script in case the style config changes or
  35   clang-format version is updated