Skip to content

Commit

Permalink
Added CMake command to dev docs for linking against librocksdb (#4725)
Browse files Browse the repository at this point in the history
In the current docs for linking against `libsrockdb`, building
`libsnappy.a` will fail because of an error thrown while building its
third party benchmarks which are enabled by default.

## Describe your changes
This PR adds the CMake CLI option to the docs so that snappy's optional
benchmarks are disabled by default.


## Issue ticket number and link
NA

## Checklist before requesting a review

- [x] If this code contains consensus-breaking changes, I have added the
"consensus-breaking" label. Otherwise, I declare my belief that there
are not consensus-breaking changes, for the following reason:

This is a one line change to developer docs for linking against a crate
dependency.
  • Loading branch information
ejmg authored Jul 22, 2024
1 parent 9976905 commit 5bc9346
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/guide/src/dev/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ git submodule update --init
# Build snappy using cmake.
mkdir build
cd build && cmake .. && make
cd build && cmake ../ -DSNAPPY_BUILD_BENCHMARKS=OFF && make
# Add an environment variable pointing to the build/ directory.
SNAPPY_LIB_DIR=`pwd`
Expand Down

0 comments on commit 5bc9346

Please sign in to comment.