Repository: mesos
Updated Branches:
refs/heads/master 444c60bea -> 98f571105
Cleaned up the flag help documentation.
The --help on master and slave have a number of issues which are
resolved with this patch:
1. Consistency - Path, location, where are all used to describe
the path of a directory or file. These are cleaned up.
2. ZK path for a file must be file:/// not file://. I get that the
last / is part of the path, however without an example it can be confusing
to newbies
3. --registration_backoff_factor help refers to a
register_backoff_factor value which is incorrect.
4. Attribute's notation really needs an example (which is added).
Review: https://reviews.apache.org/r/24057
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/98f57110
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/98f57110
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/98f57110
Branch: refs/heads/master
Commit: 98f57110599ab4269d33572dd7be0623aac615fb
Parents: 444c60b
Author: Ken Sipe <[email protected]>
Authored: Tue Jul 29 17:06:39 2014 -0700
Committer: Benjamin Mahler <[email protected]>
Committed: Tue Jul 29 17:09:43 2014 -0700
----------------------------------------------------------------------
src/logging/flags.hpp | 2 +-
src/master/flags.hpp | 5 +++--
src/master/main.cpp | 2 +-
src/slave/flags.hpp | 13 +++++++------
src/slave/main.cpp | 2 +-
5 files changed, 13 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/98f57110/src/logging/flags.hpp
----------------------------------------------------------------------
diff --git a/src/logging/flags.hpp b/src/logging/flags.hpp
index 08101b8..d30a706 100644
--- a/src/logging/flags.hpp
+++ b/src/logging/flags.hpp
@@ -47,7 +47,7 @@ public:
add(&Flags::log_dir,
"log_dir",
- "Location to put log files (no default, nothing\n"
+ "Directory path to put log files (no default, nothing\n"
"is written to disk unless specified;\n"
"does not affect logging to stderr)");
http://git-wip-us.apache.org/repos/asf/mesos/blob/98f57110/src/master/flags.hpp
----------------------------------------------------------------------
diff --git a/src/master/flags.hpp b/src/master/flags.hpp
index 32704ce..848d28b 100644
--- a/src/master/flags.hpp
+++ b/src/master/flags.hpp
@@ -61,7 +61,8 @@ public:
add(&Flags::work_dir,
"work_dir",
- "Where to store the persistent information stored in the Registry.");
+ "Directory path to store the persistent information stored in the \n"
+ "Registry. (example: /var/lib/mesos/master)");
// TODO(bmahler): Consider removing 'in_memory' as it was only
// used before 'replicated_log' was implemented.
@@ -145,7 +146,7 @@ public:
add(&Flags::webui_dir,
"webui_dir",
- "Location of the webui files/assets",
+ "Directory path of the webui files/assets",
PKGDATADIR "/webui");
add(&Flags::whitelist,
http://git-wip-us.apache.org/repos/asf/mesos/blob/98f57110/src/master/main.cpp
----------------------------------------------------------------------
diff --git a/src/master/main.cpp b/src/master/main.cpp
index 171b976..018f803 100644
--- a/src/master/main.cpp
+++ b/src/master/main.cpp
@@ -115,7 +115,7 @@ int main(int argc, char** argv)
"May be one of:\n"
" zk://host1:port1,host2:port2,.../path\n"
" zk://username:password@host1:port1,host2:port2,.../path\n"
- " file://path/to/file (where file contains one of the above)");
+ " file:///path/to/file (where file contains one of the above)");
bool help;
flags.add(&help,
http://git-wip-us.apache.org/repos/asf/mesos/blob/98f57110/src/slave/flags.hpp
----------------------------------------------------------------------
diff --git a/src/slave/flags.hpp b/src/slave/flags.hpp
index 1fe7b7d..79742dd 100644
--- a/src/slave/flags.hpp
+++ b/src/slave/flags.hpp
@@ -73,21 +73,22 @@ public:
add(&Flags::attributes,
"attributes",
- "Attributes of machine");
+ "Attributes of machine, in the form:\n"
+ "rack:2 or 'rack:2,u:1'");
add(&Flags::work_dir,
"work_dir",
- "Where to place framework work directories\n",
+ "Directory path to place framework work directories\n",
"/tmp/mesos");
add(&Flags::launcher_dir, // TODO(benh): This needs a better name.
"launcher_dir",
- "Location of Mesos binaries",
+ "Directory path of Mesos binaries",
PKGLIBEXECDIR);
add(&Flags::hadoop_home,
"hadoop_home",
- "Where to find Hadoop installed (for\n"
+ "Path to find Hadoop installed (for\n"
"fetching framework executors from HDFS)\n"
"(no default, look for HADOOP_HOME in\n"
"environment or find hadoop on PATH)",
@@ -102,13 +103,13 @@ public:
add(&Flags::frameworks_home,
"frameworks_home",
- "Directory prepended to relative executor URIs",
+ "Directory path prepended to relative executor URIs",
"");
add(&Flags::registration_backoff_factor,
"registration_backoff_factor",
"Slave initially picks a random amount of time between [0, b], where\n"
- "b = register_backoff_factor, to (re-)register with a new master.\n"
+ "b = registration_backoff_factor, to (re-)register with a new
master.\n"
"Subsequent retries are exponentially backed off based on this\n"
"interval (e.g., 1st retry uses a random value between [0, b * 2^1],\n"
"2nd retry between [0, b * 2^2], 3rd retry between [0, b * 2^3] etc)\n"
http://git-wip-us.apache.org/repos/asf/mesos/blob/98f57110/src/slave/main.cpp
----------------------------------------------------------------------
diff --git a/src/slave/main.cpp b/src/slave/main.cpp
index 8c2b70c..319316f 100644
--- a/src/slave/main.cpp
+++ b/src/slave/main.cpp
@@ -82,7 +82,7 @@ int main(int argc, char** argv)
"May be one of:\n"
" zk://host1:port1,host2:port2,.../path\n"
" zk://username:password@host1:port1,host2:port2,.../path\n"
- " file://path/to/file (where file contains one of the above)");
+ " file:///path/to/file (where file contains one of the above)");
bool help;
flags.add(&help,
