summaryrefslogtreecommitdiffstats
path: root/solenv/clang-format/README
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /solenv/clang-format/README
parentInitial commit. (diff)
downloadlibreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz
libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'solenv/clang-format/README')
-rw-r--r--solenv/clang-format/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/solenv/clang-format/README b/solenv/clang-format/README
new file mode 100644
index 000000000..fc3a8be91
--- /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 -DLLVM_BUILD_STATIC=true ..; make -j8 clang-format
+ - this produces a binary that is statically linked
+
+- 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 ==
+
+- excludelist: 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-excludelist: was used to generate `excludelist`
+
+- reformat-formatted-files: run this script in case the style config changes or
+ clang-format version is updated