[mesos] 05/06: Added documentation for installing mesos-tests.

[as...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

asekretenko pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mesos.git

commit ba18d7803923a3e8281ff97fbac338c21fa1ddf0
Author: Andrei Sekretenko <as...@apache.org>
AuthorDate: Wed May 20 23:24:30 2020 +0200

    Added documentation for installing mesos-tests.
    
    Review: https://reviews.apache.org/r/72536
---
 docs/cmake.md               | 11 ++++++++++-
 docs/configuration/cmake.md |  9 ++++++++-
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/docs/cmake.md b/docs/cmake.md
index ee5d6dc..60219e5 100644
--- a/docs/cmake.md
+++ b/docs/cmake.md
@@ -65,18 +65,27 @@ cmake -DCMAKE_INSTALL_PREFIX=/home/current_user/mesos
 cmake --build . --target install
 ```
 
+To additionally install `mesos-tests` executable and related test helpers
+(this can be used to run Mesos tests against the installed binaries),
+one can enable the `MESOS_INSTALL_TESTS` option.
+
 To produce a set of binaries and libraries that will work after being
 copied/moved to a different location, use `MESOS_FINAL_PREFIX`.
+
+The example below employs both `MESOS_FINAL_PREFIX` and `MESOS_INSTALL_TESTS`.
 On a build system:
 ```
 mkdir build && cd build
-cmake -DMESOS_FINAL_PREFIX=/opt/mesos -DCMAKE_INSTALL_PREFIX=/home/current_user/mesos
+cmake -DMESOS_FINAL_PREFIX=/opt/mesos -DCMAKE_INSTALL_PREFIX=/home/current_user/mesos -DMESOS_INSTALL_TESTS=ON
 cmake --build . --target install
 tar -czf mesos.tar.gz mesos -C /home/current_user
 ```
 On a target system:
 ```
 sudo tar -xf mesos.tar.gz -C /opt
+# Run tests against Mesos installation
+sudo /opt/mesos/bin/mesos-tests
+# Start Mesos agent
 sudo /opt/mesos/bin/mesos-agent --work-dir=/var/lib/mesos ...
 ```
 
diff --git a/docs/configuration/cmake.md b/docs/configuration/cmake.md
index 08d33dc..c3eb790 100644
--- a/docs/configuration/cmake.md
+++ b/docs/configuration/cmake.md
@@ -224,5 +224,12 @@ See more information in the [CMake documentation](../cmake.md).
       [default=`${CMAKE_INSTALL_PREFIX}`]
     </td>
   </tr>
-
+  <tr>
+    <td>
+      -DMESOS_INSTALL_TESTS=(TRUE|FALSE)
+    </td>
+    <td>
+      Add test executables and their dependencies to the install output.
+    </td>
+  </tr>
 </table>