You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by ne...@apache.org on 2017/05/31 23:49:00 UTC

[1/2] mesos git commit: Ordered configuration flag docs alphabetically.

Repository: mesos
Updated Branches:
  refs/heads/master a85a228d6 -> f3a1ad0a1


Ordered configuration flag docs alphabetically.


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/7c1c96d7
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/7c1c96d7
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/7c1c96d7

Branch: refs/heads/master
Commit: 7c1c96d712a4c3a9e0ffd579e542cbd074fa964e
Parents: a85a228
Author: Neil Conway <ne...@gmail.com>
Authored: Wed May 31 15:39:50 2017 -0700
Committer: Neil Conway <ne...@gmail.com>
Committed: Wed May 31 16:48:49 2017 -0700

----------------------------------------------------------------------
 docs/configuration.md | 106 ++++++++++++++++++++++-----------------------
 1 file changed, 53 insertions(+), 53 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/7c1c96d7/docs/configuration.md
----------------------------------------------------------------------
diff --git a/docs/configuration.md b/docs/configuration.md
index 6703b9e..b88344a 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -120,91 +120,65 @@ Show the help message and exit. (default: false)
 </tr>
 <tr>
   <td>
-    --http_authenticators=VALUE
-  </td>
-  <td>
-HTTP authenticator implementation to use when handling requests to
-authenticated endpoints. Use the default
-<code>basic</code>, or load an alternate
-HTTP authenticator module using <code>--modules</code>.
-(default: basic, or basic and JWT if executor authentication is enabled)
-  </td>
-</tr>
-<tr>
-  <td>
-    --ip=VALUE
-  </td>
-  <td>
-IP address to listen on. This cannot be used in conjunction
-with <code>--ip_discovery_command</code>. (master default: 5050; agent default: 5051)
-  </td>
-</tr>
-<tr>
-  <td>
-    --ip_discovery_command=VALUE
-  </td>
-  <td>
-Optional IP discovery binary: if set, it is expected to emit
-the IP address which the master/agent will try to bind to.
-Cannot be used in conjunction with <code>--ip</code>.
-  </td>
-</tr>
-<tr>
-  <td>
-    --modules_dir=VALUE
+    --hooks=VALUE
   </td>
   <td>
-Directory path of the module manifest files. The manifest files are processed in
-alphabetical order. (See <code>--modules</code> for more information on module
-manifest files) Cannot be used in conjunction with <code>--modules</code>.
+A comma-separated list of hook modules to be installed inside master/agent.
   </td>
 </tr>
 <tr>
   <td>
-    --port=VALUE
+    --hostname=VALUE
   </td>
   <td>
-Port to listen on.
+The hostname the agent node should report, or that the master
+should advertise in ZooKeeper.
+If left unset, the hostname is resolved from the IP address
+that the master/agent binds to; unless the user explicitly prevents
+that, using <code>--no-hostname_lookup</code>, in which case the IP itself
+is used.
   </td>
 </tr>
 <tr>
   <td>
-    --[no-]version
+    --[no-]hostname_lookup
   </td>
   <td>
-Show version and exit. (default: false)
+Whether we should execute a lookup to find out the server's hostname,
+if not explicitly set (via, e.g., <code>--hostname</code>).
+True by default; if set to <code>false</code> it will cause Mesos
+to use the IP address, unless the hostname is explicitly set. (default: true)
   </td>
 </tr>
 <tr>
   <td>
-    --hooks=VALUE
+    --http_authenticators=VALUE
   </td>
   <td>
-A comma-separated list of hook modules to be installed inside master/agent.
+HTTP authenticator implementation to use when handling requests to
+authenticated endpoints. Use the default
+<code>basic</code>, or load an alternate
+HTTP authenticator module using <code>--modules</code>.
+(default: basic, or basic and JWT if executor authentication is enabled)
   </td>
 </tr>
 <tr>
   <td>
-    --hostname=VALUE
+    --ip=VALUE
   </td>
   <td>
-The hostname the agent node should report, or that the master
-should advertise in ZooKeeper.
-If left unset, the hostname is resolved from the IP address
-that the master/agent binds to; unless the user explicitly prevents
-that, using <code>--no-hostname_lookup</code>, in which case the IP itself
-is used.
+IP address to listen on. This cannot be used in conjunction
+with <code>--ip_discovery_command</code>. (master default: 5050; agent default: 5051)
   </td>
 </tr>
 <tr>
   <td>
-    --[no-]hostname_lookup
+    --ip_discovery_command=VALUE
   </td>
   <td>
-Whether we should execute a lookup to find out the server's hostname,
-if not explicitly set (via, e.g., <code>--hostname</code>).
-True by default; if set to <code>false</code> it will cause Mesos
-to use the IP address, unless the hostname is explicitly set. (default: true)
+Optional IP discovery binary: if set, it is expected to emit
+the IP address which the master/agent will try to bind to.
+Cannot be used in conjunction with <code>--ip</code>.
   </td>
 </tr>
 <tr>
@@ -254,6 +228,32 @@ Example:
 <p/> Cannot be used in conjunction with --modules_dir.
   </td>
 </tr>
+<tr>
+  <td>
+    --modules_dir=VALUE
+  </td>
+  <td>
+Directory path of the module manifest files. The manifest files are processed in
+alphabetical order. (See <code>--modules</code> for more information on module
+manifest files) Cannot be used in conjunction with <code>--modules</code>.
+  </td>
+</tr>
+<tr>
+  <td>
+    --port=VALUE
+  </td>
+  <td>
+Port to listen on.
+  </td>
+</tr>
+<tr>
+  <td>
+    --[no-]version
+  </td>
+  <td>
+Show version and exit. (default: false)
+  </td>
+</tr>
 </table>
 
 *These logging options can also be supplied to both masters and agents.*


[2/2] mesos git commit: Fixed various minor stylistic issues with flag help text.

Posted by ne...@apache.org.
Fixed various minor stylistic issues with flag help text.


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/f3a1ad0a
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/f3a1ad0a
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/f3a1ad0a

Branch: refs/heads/master
Commit: f3a1ad0a1e15136196b3e093cb89083e2db8a0a7
Parents: 7c1c96d
Author: Neil Conway <ne...@gmail.com>
Authored: Wed May 31 16:16:43 2017 -0700
Committer: Neil Conway <ne...@gmail.com>
Committed: Wed May 31 16:48:55 2017 -0700

----------------------------------------------------------------------
 docs/configuration.md | 32 +++++++++++++++-----------------
 src/logging/flags.cpp |  4 ++--
 src/master/flags.cpp  | 20 +++++++++-----------
 src/sched/flags.hpp   |  2 +-
 src/slave/flags.cpp   |  4 ++--
 src/tests/flags.hpp   |  2 +-
 6 files changed, 30 insertions(+), 34 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/f3a1ad0a/docs/configuration.md
----------------------------------------------------------------------
diff --git a/docs/configuration.md b/docs/configuration.md
index b88344a..5fd1e89 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -7,8 +7,8 @@ layout: documentation
 # Mesos Configuration
 
 The Mesos master and agent can take a variety of configuration options
-through command-line arguments, or environment variables. A list of
-the available options can be seen by running `mesos-master --help` or
+through command-line arguments or environment variables. A list of the
+available options can be seen by running `mesos-master --help` or
 `mesos-agent --help`. Each option can be set in two ways:
 
 * By passing it to the binary using `--option_name=value`, either
@@ -156,9 +156,8 @@ to use the IP address, unless the hostname is explicitly set. (default: true)
   </td>
   <td>
 HTTP authenticator implementation to use when handling requests to
-authenticated endpoints. Use the default
-<code>basic</code>, or load an alternate
-HTTP authenticator module using <code>--modules</code>.
+authenticated endpoints. Use the default <code>basic</code>, or load an
+alternate HTTP authenticator module using <code>--modules</code>.
 (default: basic, or basic and JWT if executor authentication is enabled)
   </td>
 </tr>
@@ -235,7 +234,7 @@ Example:
   <td>
 Directory path of the module manifest files. The manifest files are processed in
 alphabetical order. (See <code>--modules</code> for more information on module
-manifest files) Cannot be used in conjunction with <code>--modules</code>.
+manifest files). Cannot be used in conjunction with <code>--modules</code>.
   </td>
 </tr>
 <tr>
@@ -275,7 +274,7 @@ For more about logging, see the [logging documentation](logging.md).
     --[no-]quiet
   </td>
   <td>
-Disable logging to stderr (default: false)
+Disable logging to stderr. (default: false)
   </td>
 </tr>
 <tr>
@@ -316,7 +315,7 @@ written to <code>--log_dir</code>, if specified. (default: INFO)
   </td>
   <td>
 Whether the master/agent should initialize Google logging for the
-Mesos scheduler and executor drivers, in same way as described here.
+scheduler and executor drivers, in the same way as described here.
 The scheduler/executor drivers have separate logs and do not get
 written to the master/agent logs.
 <p/>
@@ -386,7 +385,7 @@ lose data when cleanup occurs. (Example: <code>/var/lib/mesos/master</code>)
     --zk=VALUE
   </td>
   <td>
-ZooKeeper URL (used for leader election amongst masters)
+ZooKeeper URL (used for leader election amongst masters).
 May be one of:
 <pre><code>zk://host1:port1,host2:port2,.../path
 zk://username:password@host1:port1,host2:port2,.../path
@@ -651,9 +650,9 @@ the following for more information:
     --framework_sorter=VALUE
   </td>
   <td>
-Policy to use for allocating resources
-between a given user's frameworks. Options
-are the same as for user_allocator. (default: drf)
+Policy to use for allocating resources between a given user's
+frameworks. Options are the same as for <code>--user_sorter</code>.
+(default: drf)
   </td>
 </tr>
 <tr>
@@ -848,8 +847,7 @@ Can root submit frameworks? (default: true)
     --user_sorter=VALUE
   </td>
   <td>
-Policy to use for allocating resources
-between users. May be one of:
+Policy to use for allocating resources between users. May be one of:
   dominant_resource_fairness (drf) (default: drf)
   </td>
 </tr>
@@ -879,9 +877,9 @@ using the <code>/weights</code> HTTP endpoint.
   </td>
   <td>
 Path to a file which contains a list of agents (one per line) to
-advertise offers for. The file is watched, and periodically re-read to
-refresh the agent whitelist. By default there is no whitelist / all
-machines are accepted. Path could be of the form
+advertise offers for. The file is watched and periodically re-read to
+refresh the agent whitelist. By default there is no whitelist: all
+machines are accepted. Path can be of the form
 <code>file:///path/to/file</code> or <code>/path/to/file</code>.
   </td>
 </tr>

http://git-wip-us.apache.org/repos/asf/mesos/blob/f3a1ad0a/src/logging/flags.cpp
----------------------------------------------------------------------
diff --git a/src/logging/flags.cpp b/src/logging/flags.cpp
index db8fd3e..3396604 100644
--- a/src/logging/flags.cpp
+++ b/src/logging/flags.cpp
@@ -21,7 +21,7 @@ mesos::internal::logging::Flags::Flags()
 {
   add(&Flags::quiet,
       "quiet",
-      "Disable logging to stderr",
+      "Disable logging to stderr.",
       false);
 
   add(&Flags::logging_level,
@@ -49,7 +49,7 @@ mesos::internal::logging::Flags::Flags()
   add(&Flags::initialize_driver_logging,
       "initialize_driver_logging",
       "Whether the master/agent should initialize Google logging for the\n"
-      "Mesos scheduler and executor drivers, in same way as described here.\n"
+      "scheduler and executor drivers, in the same way as described here.\n"
       "The scheduler/executor drivers have separate logs and do not get\n"
       "written to the master/agent logs.\n\n"
       "This option has no effect when using the HTTP scheduler/executor APIs.\n"

http://git-wip-us.apache.org/repos/asf/mesos/blob/f3a1ad0a/src/master/flags.cpp
----------------------------------------------------------------------
diff --git a/src/master/flags.cpp b/src/master/flags.cpp
index eee5ec7..ca5f02c 100644
--- a/src/master/flags.cpp
+++ b/src/master/flags.cpp
@@ -171,23 +171,21 @@ mesos::internal::master::Flags::Flags()
   add(&Flags::whitelist,
       "whitelist",
       "Path to a file which contains a list of agents (one per line) to\n"
-      "advertise offers for. The file is watched, and periodically re-read to\n"
-      "refresh the agent whitelist. By default there is no whitelist / all\n"
-      "machines are accepted. Path could be of the form\n"
+      "advertise offers for. The file is watched and periodically re-read to\n"
+      "refresh the agent whitelist. By default there is no whitelist: all\n"
+      "machines are accepted. Path can be of the form\n"
       "`file:///path/to/file` or `/path/to/file`.\n");
 
   add(&Flags::user_sorter,
       "user_sorter",
-      "Policy to use for allocating resources\n"
-      "between users. May be one of:\n"
+      "Policy to use for allocating resources between users. May be one of:\n"
       "  dominant_resource_fairness (drf)",
       "drf");
 
   add(&Flags::framework_sorter,
       "framework_sorter",
-      "Policy to use for allocating resources\n"
-      "between a given user's frameworks. Options\n"
-      "are the same as for user_allocator.",
+      "Policy to use for allocating resources between a given user's\n"
+      "frameworks. Options are the same as for `--user_sorter`.",
       "drf");
 
   add(&Flags::allocation_interval,
@@ -433,7 +431,7 @@ mesos::internal::master::Flags::Flags()
       "modules_dir",
       "Directory path of the module manifest files.\n"
       "The manifest files are processed in alphabetical order.\n"
-      "(See --modules for more information on module manifest files)\n"
+      "(See --modules for more information on module manifest files).\n"
       "Cannot be used in conjunction with --modules.\n");
 
   add(&Flags::authenticators,
@@ -531,7 +529,7 @@ mesos::internal::master::Flags::Flags()
   add(&Flags::http_authenticators,
       "http_authenticators",
       "HTTP authenticator implementation to use when handling requests to\n"
-      "authenticated endpoints. Use the default\n"
+      "authenticated endpoints. Use the default "
       "`" + string(DEFAULT_BASIC_HTTP_AUTHENTICATOR) + "`, or load an\n"
       "alternate HTTP authenticator module using `--modules`.\n"
       "\n"
@@ -631,7 +629,7 @@ mesos::internal::master::Flags::Flags()
 
   add(&Flags::zk,
       "zk",
-      "ZooKeeper URL (used for leader election amongst masters)\n"
+      "ZooKeeper URL (used for leader election amongst masters).\n"
       "May be one of:\n"
       "  `zk://host1:port1,host2:port2,.../path`\n"
       "  `zk://username:password@host1:port1,host2:port2,.../path`\n"

http://git-wip-us.apache.org/repos/asf/mesos/blob/f3a1ad0a/src/sched/flags.hpp
----------------------------------------------------------------------
diff --git a/src/sched/flags.hpp b/src/sched/flags.hpp
index d19d20b..2492665 100644
--- a/src/sched/flags.hpp
+++ b/src/sched/flags.hpp
@@ -109,7 +109,7 @@ public:
         "modules_dir",
         "Directory path of the module manifest files.\n"
         "The manifest files are processed in alphabetical order.\n"
-        "(See --modules for more information on module manifest files)\n"
+        "(See --modules for more information on module manifest files).\n"
         "Cannot be used in conjunction with --modules.\n");
 
     add(&Flags::authenticatee,

http://git-wip-us.apache.org/repos/asf/mesos/blob/f3a1ad0a/src/slave/flags.cpp
----------------------------------------------------------------------
diff --git a/src/slave/flags.cpp b/src/slave/flags.cpp
index 1419d51..e7b65a4 100644
--- a/src/slave/flags.cpp
+++ b/src/slave/flags.cpp
@@ -921,7 +921,7 @@ mesos::internal::slave::Flags::Flags()
       "modules_dir",
       "Directory path of the module manifest files.\n"
       "The manifest files are processed in alphabetical order.\n"
-      "(See --modules for more information on module manifest files)\n"
+      "(See --modules for more information on module manifest files).\n"
       "Cannot be used in conjunction with --modules.\n");
 
   add(&Flags::authenticatee,
@@ -946,7 +946,7 @@ mesos::internal::slave::Flags::Flags()
   add(&Flags::http_authenticators,
       "http_authenticators",
       "HTTP authenticator implementation to use when handling requests to\n"
-      "authenticated endpoints. Use the default\n"
+      "authenticated endpoints. Use the default "
       "`" + string(DEFAULT_BASIC_HTTP_AUTHENTICATOR) + "`, or load an\n"
       "alternate HTTP authenticator module using `--modules`.");
 

http://git-wip-us.apache.org/repos/asf/mesos/blob/f3a1ad0a/src/tests/flags.hpp
----------------------------------------------------------------------
diff --git a/src/tests/flags.hpp b/src/tests/flags.hpp
index 664782d..0050fc9 100644
--- a/src/tests/flags.hpp
+++ b/src/tests/flags.hpp
@@ -143,7 +143,7 @@ public:
         "modules_dir",
         "Directory path of the module manifest files.\n"
         "The manifest files are processed in alphabetical order.\n"
-        "(See --modules for more information on module manifest files)\n"
+        "(See --modules for more information on module manifest files).\n"
         "Cannot be used in conjunction with --modules.\n");
 
     // This help message is duplicated from slave/flags.hpp and