You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by jo...@apache.org on 2017/02/15 21:40:41 UTC
[5/7] mesos git commit: Added CMake to standard documentation.
Added CMake to standard documentation.
This qualifies the existing "configure" options with "autotools"
to differentiate them from CMake build options. And this adds
CMake build options to a separate document. This new document
may be extended in future to document more of the features,
practices, or nuances of the CMake build.
Review: https://reviews.apache.org/r/55749/
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/ccbcf00c
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/ccbcf00c
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/ccbcf00c
Branch: refs/heads/master
Commit: ccbcf00cce2840edfd6af3a1be7032f56e5b628a
Parents: 8b18106
Author: Alex Clemmer <cl...@gmail.com>
Authored: Tue Feb 14 14:01:18 2017 -0800
Committer: Joseph Wu <jo...@apache.org>
Committed: Wed Feb 15 13:40:20 2017 -0800
----------------------------------------------------------------------
docs/configuration-cmake.md | 87 ++++++++++++++++++++++++++++++++++++++++
docs/configuration.md | 8 ++--
docs/home.md | 2 +-
3 files changed, 92 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/ccbcf00c/docs/configuration-cmake.md
----------------------------------------------------------------------
diff --git a/docs/configuration-cmake.md b/docs/configuration-cmake.md
new file mode 100644
index 0000000..4115e60
--- /dev/null
+++ b/docs/configuration-cmake.md
@@ -0,0 +1,87 @@
+---
+title: Apache Mesos - CMake Configuration
+layout: documentation
+---
+
+# Mesos CMake Build Configuration Options
+
+Mesos currently exposes two build systems, one written in
+[autotools](configuration.md), and one written in CMake.
+This document describes the configuration flags available in
+the CMake build system.
+
+
+## CMake configuration options
+
+<table class="table table-striped">
+ <thead>
+ <tr>
+ <th width="30%">
+ Flag
+ </th>
+ <th>
+ Explanation
+ </th>
+ </tr>
+ </thead>
+ <tr>
+ <td>
+ -D3RDPARTY_DEPENDENCIES[=path_or_url]
+ </td>
+ <td>
+ Location of the dependency mirror. In some cases, the Mesos build system
+ needs to acquire third-party dependencies that aren't rebundled as
+ tarballs in the Mesos repository. For example, on Windows, we must aquire
+ newer versions of some dependencies, and since Windows does not have a
+ package manager, we must acquire system dependencies like cURL. This
+ parameter can be either a URL (for example, pointing at the Mesos official
+ [third-party dependency mirror](https://github.com/3rdparty/mesos-3rdparty)),
+ or a local folder (for example, a local clone of the dependency mirror).
+ [default=https://github.com/3rdparty/mesos-3rdparty]
+ </td>
+ </tr>
+ <tr>
+ <td>
+ -DENABLE_LIBEVENT
+ </td>
+ <td>
+ Use libevent instead of libev for the event loop. [default=FALSE]
+ </td>
+ </tr>
+ <tr>
+ <td>
+ -DHAS_AUTHENTICATION
+ </td>
+ <td>
+ Build Mesos with support for authentication. [default=TRUE]
+ </td>
+ </tr>
+ <tr>
+ <td>
+ -DREBUNDLED
+ </td>
+ <td>
+ Attempt to build against the third-party dependencies included as
+ tarballs in the Mesos repository.
+
+ NOTE: This is not always possible. For example, a dependency might
+ not be included as a tarball in the Mesos repository; additionally,
+ Windows does not have a package manager, so we do not expect system
+ dependencies like APR to exist natively, and we therefore must acquire
+ them. In these cases (or when `REBUNDLED` is set to `FALSE`), we will
+ acquire the dependency from the location specified by the
+ `3RDPARTY_DEPENDENCIES`, which by default points to the official Mesos
+ [third-party dependency mirror](https://github.com/3rdparty/mesos-3rdparty).
+ [default=TRUE]
+ </td>
+ </tr>
+ <tr>
+ <td>
+ -DVERBOSE
+ </td>
+ <td>
+ Generate a build solution that produces verbose output
+ (for example, verbose Makefiles). [default=TRUE]
+ </td>
+ </tr>
+</table>
http://git-wip-us.apache.org/repos/asf/mesos/blob/ccbcf00c/docs/configuration.md
----------------------------------------------------------------------
diff --git a/docs/configuration.md b/docs/configuration.md
index 656aaa3..b3e1f8e 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -2061,9 +2061,9 @@ quotas for container sandbox directories. Valid project IDs range from
</table>
-## Mesos Build Configuration Options
+## Mesos Autotools Build Configuration Options
-###The configure script has the following flags for optional features:
+### Autotools `configure` script options
<table class="table table-striped">
<thead>
@@ -2300,7 +2300,7 @@ quotas for container sandbox directories. Valid project IDs range from
</tr>
</table>
-### The configure script has the following flags for optional packages:
+### Autotools `configure` script optional package flags
<table class="table table-striped">
<thead>
@@ -2521,7 +2521,7 @@ quotas for container sandbox directories. Valid project IDs range from
</tr>
</table>
-### Some influential environment variables for configure script:
+### Environment variables which affect the Autotools `configure` script
Use these variables to override the choices made by `configure` or to help
it to find libraries and programs with nonstandard names/locations.
http://git-wip-us.apache.org/repos/asf/mesos/blob/ccbcf00c/docs/home.md
----------------------------------------------------------------------
diff --git a/docs/home.md b/docs/home.md
index 091dae2..8296f84 100644
--- a/docs/home.md
+++ b/docs/home.md
@@ -18,7 +18,7 @@ layout: documentation
* [Agent Recovery](agent-recovery.md) for doing seamless agent upgrades and allowing executors to survive `mesos-agent` crashes.
* [Authentication](authentication.md)
* [Authorization](authorization.md)
-* [Configuration](configuration.md) for command-line arguments.
+* [Configuration](configuration.md) and [CMake configuration](configuration-cmake.md) for command-line arguments.
* [Container Image](container-image.md) for supporting container images in Mesos containerizer.
* [Containerizer](containerizer.md) for containerizer overview and use cases.
* [Containerizer Internals](containerizer-internals.md) for implementation details of containerizers.