github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/c-deps/libroach/README.md (about)

     1  # Sources for libroach.
     2  
     3  ## Formatting
     4  
     5  Code is formatted using [clang-format](https://clang.llvm.org/docs/ClangFormat.html).
     6  
     7  To install:
     8  * download [LLVM  5.0 for your OS/arch](http://releases.llvm.org/download.html#5.0.0)
     9  * extract archive
    10  * place the archive's `bin/clang-format` in your path
    11  
    12  If you use a package manager, make sure it uses clang-format from LLVM 5.0 (`clang-format --version`).
    13  
    14  To use, do one of:
    15  * run `make c-deps-fmt` from the `cockroachdb/cockroach` repo
    16  * add `clang-format -i <filename>` as a save hook in your editor.
    17  
    18  ## Testing
    19  
    20  Run `make check-libroach` from the repository root. We use [gtest].
    21  
    22  [gtest]: https://github.com/google/googletest