diff options
| author | Miklos Vajna <vmiklos@collabora.co.uk> | 2017-12-07 09:09:35 +0100 |
|---|---|---|
| committer | Miklos Vajna <vmiklos@collabora.co.uk> | 2017-12-07 11:21:25 +0100 |
| commit | caf1eb15838729e05a70d2fcb8de6834394b5764 (patch) | |
| tree | 7e139c5a7b29116cae7e9b5615d172bea42139c1 | |
| parent | 03fa6b15439938044fa95eb9b0584d16cf23db88 (diff) | |
solenv: add clang-format documentation
Change-Id: Ia1231fb16c351cf957bafaf07ed0ff0e4ff896dd
Reviewed-on: https://gerrit.libreoffice.org/46008
Reviewed-by: Miklos Vajna <vmiklos@collabora.co.uk>
Tested-by: Jenkins <ci@libreoffice.org>
| -rw-r--r-- | solenv/clang-format/README | 35 | ||||
| -rw-r--r-- | solenv/clang-format/blacklist | 2 |
2 files changed, 35 insertions, 2 deletions
diff --git a/solenv/clang-format/README b/solenv/clang-format/README new file mode 100644 index 000000000000..602dfc6eb254 --- /dev/null +++ b/solenv/clang-format/README @@ -0,0 +1,35 @@ +Style enforcing code. + +== How to reproduce the binaries at <https://dev-www.libreoffice.org/bin/> == + +- Linux: + + - Built from source on openSUSE Leap 42.3 + - get <http://releases.llvm.org/5.0.0/llvm-5.0.0.src.tar.xz> + - 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 + - mkdir workdir; cd workdir; cmake -G 'Unix Makefiles' -DCMAKE_INSTALL_PREFIX=$PWD/../instdir -DCMAKE_BUILD_TYPE=Release ..; make -j8 clang-format + - this produces a binary that is dynamically linked, but all LLVM/clang libs are linked in statically + +- macOS: + + - <http://releases.llvm.org/5.0.0/clang+llvm-5.0.0-x86_64-apple-darwin.tar.xz> provides a portable binary already + +- Windows: + + - <http://releases.llvm.org/5.0.0/LLVM-5.0.0-win32.exe> provides a portable binary already + +== Directory contents == + +- blacklist: list of existing files not to be formatted: + + - if you rename a file mentioned in this list, please update the entry (and + keep the file sorted) + +- check-last-commit: this is used during gerrit / jenkins verification + +- ClangFormat.pm: shared code between the git hook and these scripts + +- generate-style-blacklist: was used to generate `blacklist` + +- reformat-formatted-files: run this script in case the style config changes or + clang-format version is updated diff --git a/solenv/clang-format/blacklist b/solenv/clang-format/blacklist index 272dc4e5c295..202f3ecfde84 100644 --- a/solenv/clang-format/blacklist +++ b/solenv/clang-format/blacklist @@ -8292,8 +8292,6 @@ io/test/stm/testfactreg.cxx io/test/stm/testfactreg.hxx io/test/testcomponent.cxx io/test/testconnection.cxx -ios/LibreOfficeKit/LibreOfficeKit/LibreOfficeKit.c -ios/LibreOfficeKit/LibreOfficeKit/LibreOfficeKit.h ios/LibreOfficeLight/LibreOfficeLight/dummyLOkit.c ios/LibreOfficeLight/LibreOfficeLight/lokit-Bridging-Header.h ios/source/LibreOfficeKit.c |