From f7cffb602b4e1d7655c0d7455305c147f2a7b10c Mon Sep 17 00:00:00 2001 From: Jan Tattermusch Date: Thu, 6 Feb 2020 08:56:52 +0100 Subject: [PATCH] improve the docs --- BUILDING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index f5da8141647..9addae90fc7 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -184,7 +184,7 @@ ie `gRPC_CARES_PROVIDER`. ### Install after build Perform the following steps to install gRPC using CMake. -* Set `gRPC_INSTALL` to `ON` +* Set `-DgRPC_INSTALL=ON` * Build the `install` target The install destination is controlled by the @@ -197,9 +197,14 @@ in "module" mode and install them alongside gRPC in a single step. If you are using an older version of gRPC, you will need to select "package" mode (rather than "module" mode) for the dependencies. This means you will need to have external copies of these libraries available -on your system. +on your system. This [example](test/distrib/cpp/run_distrib_test_cmake.sh) shows +how to install dependencies with cmake before proceeding to installing gRPC itself. + ``` -$ cmake ../.. -DgRPC_INSTALL=ON \ +# NOTE: all of gRPC's dependencies need to be already installed +$ cmake ../.. -DgRPC_INSTALL=ON \ + -DCMAKE_BUILD_TYPE=Release \ + -DgRPC_ABSL_PROVIDER=package \ -DgRPC_CARES_PROVIDER=package \ -DgRPC_PROTOBUF_PROVIDER=package \ -DgRPC_SSL_PROVIDER=package \ @@ -207,7 +212,6 @@ $ cmake ../.. -DgRPC_INSTALL=ON \ $ make $ make install ``` -[Example](test/distrib/cpp/run_distrib_test_cmake.sh) ### Cross-compiling