Skip to content

README.md

Latest commit

 

History

History
36 lines (35 loc) · 2.17 KB

README.md

File metadata and controls

36 lines (35 loc) · 2.17 KB

Scripts

This directory contains scripts that are useful during development.

  • bazel-build builds the library using Bazel via bazelisk.
  • benchmark builds the library and its benchmark, and runs the benchmark.
  • check performs some of the checks that continuous integration performs. It's convenient to run this script before pushing changes.
  • check-format verifies that the source code is formatted as format prefers.
  • check-version accepts a version string as a command line argument (e.g. "v1.2.3") and checks whether the version within the source code matches. This is a good check to perform before publishing a source release.
  • cmake-build builds the library using CMake.
  • format formats all of the C++ source code using clang-format-14.
  • hasher-example builds the library, including the command line example program, and then runs the example.
  • http-server-example runs the docker compose based HTTP server example.
  • install-cmake installs a recent version of CMake if a more recent version is not installed already.
  • install-lcov installs a version of GNU's code coverage HTML report generator that's recent enough to support dark mode.
  • release checks the provided version string (e.g. "v1.2.3") and then publishes a "draft" "prerelease" GitHub source release, which you then can alter and document in the GitHub web UI.
  • test builds the library, including the unit tests, and then runs the unit tests.
  • with-toolchain is a command wrapper that sets the CC and CXX environment variables based on its first argument, which is either "gnu" (to use the gcc/g++ toolchain) or "llvm" (to use the clang/clang++ toolchain). For example: with-toolchain llvm cmake -DDD_TRACE_BUILD_TESTING=1 ...