You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by me...@apache.org on 2015/11/08 13:43:44 UTC
[2/2] mesos git commit: Fixed hyphenation,
typos in configuration docs and command-line flags.
Fixed hyphenation, typos in configuration docs and command-line flags.
Review: https://reviews.apache.org/r/40029
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/249bc263
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/249bc263
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/249bc263
Branch: refs/heads/master
Commit: 249bc26306574d9db0527c04b7a83a1f1e75f71b
Parents: 1e7be5c
Author: Neil Conway <ne...@gmail.com>
Authored: Sun Nov 8 00:44:11 2015 -0800
Committer: Adam B <ad...@mesosphere.io>
Committed: Sun Nov 8 00:46:01 2015 -0800
----------------------------------------------------------------------
docs/authorization.md | 6 +++---
docs/configuration.md | 32 ++++++++++++++++----------------
docs/modules.md | 2 +-
src/master/flags.cpp | 20 ++++++++++----------
src/slave/flags.cpp | 18 +++++++++---------
src/tests/flags.hpp | 2 +-
src/tests/repair_tests.cpp | 2 +-
src/zookeeper/zookeeper.hpp | 2 +-
8 files changed, 42 insertions(+), 42 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/docs/authorization.md
----------------------------------------------------------------------
diff --git a/docs/authorization.md b/docs/authorization.md
index 16a1866..f5ed75f 100644
--- a/docs/authorization.md
+++ b/docs/authorization.md
@@ -165,12 +165,12 @@ There are couple of important things to note:
}
-## Enabling authorization.
+## Enabling authorization
As part of this feature, a new flag was added to the master.
-* `acls` : The value could be a JSON formatted string of ACLs
- or a file path containing the JSON formatted ACLs used
+* `acls` : The value could be a JSON-formatted string of ACLs
+ or a file path containing the JSON-formatted ACLs used
for authorization. Path could be of the form 'file:///path/to/file'
or '/path/to/file'.
See the ACLs protobuf in mesos.proto for the expected format.
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/docs/configuration.md
----------------------------------------------------------------------
diff --git a/docs/configuration.md b/docs/configuration.md
index 195814c..e437edd 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -47,8 +47,8 @@ If you have special compilation requirements, please refer to `./configure --hel
--firewall_rules=VALUE
</td>
<td>
- The value could be a JSON formatted string of rules or a file path
- containing the JSON formated rules used in the endpoints firewall. Path
+ The value could be a JSON-formatted string of rules or a file path
+ containing the JSON-formatted rules used in the endpoints firewall. Path
could be of the form <code>file:///path/to/file</code> or
<code>/path/to/file</code>.
<p/>
@@ -250,9 +250,9 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--acls=VALUE
</td>
<td>
- The value is a JSON formatted string of ACLs. Remember you can also use
+ The value is a JSON-formatted string of ACLs. Remember you can also use
the <code>file:///path/to/file</code> or <code>/path/to/file</code>
- argument value format to write the JSON in a file.
+ argument value format to read the JSON from a file.
<p/>
See the ACLs protobuf in mesos.proto for the expected format.
<p/>
@@ -398,7 +398,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--hooks=VALUE
</td>
<td>
- A comma separated list of hook modules to be
+ A comma-separated list of hook modules to be
installed inside master.
</td>
</tr>
@@ -455,7 +455,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
subsystems.
<p/>
Use <code>--modules=filepath</code> to specify the list of modules via a
- file containing a JSON formatted string.
+ file containing a JSON-formatted string.
Remember you can also use the <code>file:///path/to/file</code> or
<code>/path/to/file</code> argument value format to write the JSON in a
file.<p/>
@@ -510,13 +510,13 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--rate_limits=VALUE
</td>
<td>
- The value could be a JSON formatted string of rate limits
- or a file path containing the JSON formatted rate limits used
+ The value could be a JSON-formatted string of rate limits
+ or a file path containing the JSON-formatted rate limits used
for framework rate limiting.
<p/>
Remember you can also use
the <code>file:///path/to/file</code> or <code>/path/to/file</code>
- argument value format to write the JSON in a file.
+ argument value format to read the JSON from a file.
<p/>
See the RateLimits protobuf in mesos.proto for the expected format.
@@ -607,7 +607,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--roles=VALUE
</td>
<td>
- A comma separated list of the allocation
+ A comma-separated list of the allocation
roles that frameworks in this cluster may
belong to.
</td>
@@ -680,7 +680,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--weights=VALUE
</td>
<td>
- A comma separated list of role/weight pairs
+ A comma-separated list of role/weight pairs
of the form 'role=weight,role=weight'. Weights
are used to indicate forms of priority.
</td>
@@ -897,7 +897,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--containerizers=VALUE
</td>
<td>
- Comma separated list of containerizer implementations
+ Comma-separated list of containerizer implementations
to compose in order to provide containerization.
<p/>
Available options are 'mesos', 'external', and
@@ -916,7 +916,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
containing 'principal' and 'secret' separated by whitespace.
<p/>
- Or a path containing the JSON formatted information used for one credential.
+ Or a path containing the JSON-formatted information used for one credential.
<p/>
Path should be of the form <code>file://path/to/file</code>.
<p/>
@@ -946,7 +946,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--default_container_info=VALUE
</td>
<td>
- JSON formatted ContainerInfo that will be included into
+ JSON-formatted ContainerInfo that will be included into
any ExecutorInfo that does not specify a ContainerInfo.
<p/>
See the ContainerInfo protobuf in mesos.proto for
@@ -1154,7 +1154,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--hooks=VALUE
</td>
<td>
- A comma separated list of hook modules to be
+ A comma-separated list of hook modules to be
installed inside master.
</td>
</tr>
@@ -1220,7 +1220,7 @@ file:///path/to/file (where file contains one of the above)</code></pre>
--image_providers=VALUE
</td>
<td>
- Comma separated list of supported image providers, e.g., 'APPC,DOCKER'.
+ Comma-separated list of supported image providers, e.g., 'APPC,DOCKER'.
</td>
</tr>
<tr>
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/docs/modules.md
----------------------------------------------------------------------
diff --git a/docs/modules.md b/docs/modules.md
index b8693c0..1aad8e0 100644
--- a/docs/modules.md
+++ b/docs/modules.md
@@ -36,7 +36,7 @@ tests to specify a list of modules to be loaded and be available to the internal
subsystems.
Use `--modules=filepath` to specify the list of modules via a
-file containing a JSON formatted string. 'filepath' can be
+file containing a JSON-formatted string. 'filepath' can be
of the form 'file:///path/to/file' or '/path/to/file'.
Use `--modules="{...}"` to specify the list of modules inline.
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/src/master/flags.cpp
----------------------------------------------------------------------
diff --git a/src/master/flags.cpp b/src/master/flags.cpp
index 0285ce7..806e2da 100644
--- a/src/master/flags.cpp
+++ b/src/master/flags.cpp
@@ -186,13 +186,13 @@ mesos::internal::master::Flags::Flags()
// TODO(vinod): Deprecate this in favor of '--acls'.
add(&Flags::roles,
"roles",
- "A comma separated list of the allocation\n"
+ "A comma-separated list of the allocation\n"
"roles that frameworks in this cluster may\n"
"belong to.");
add(&Flags::weights,
"weights",
- "A comma separated list of role/weight pairs\n"
+ "A comma-separated list of role/weight pairs\n"
"of the form 'role=weight,role=weight'. Weights\n"
"are used to indicate forms of priority.");
@@ -232,8 +232,8 @@ mesos::internal::master::Flags::Flags()
add(&Flags::acls,
"acls",
- "The value could be a JSON formatted string of ACLs\n"
- "or a file path containing the JSON formatted ACLs used\n"
+ "The value could be a JSON-formatted string of ACLs\n"
+ "or a file path containing the JSON-formatted ACLs used\n"
"for authorization. Path could be of the form 'file:///path/to/file'\n"
"or '/path/to/file'.\n"
"\n"
@@ -266,8 +266,8 @@ mesos::internal::master::Flags::Flags()
add(&Flags::firewall_rules,
"firewall_rules",
- "The value could be a JSON formatted string of rules or a\n"
- "file path containing the JSON formated rules used in the endpoints\n"
+ "The value could be a JSON-formatted string of rules or a\n"
+ "file path containing the JSON-formatted rules used in the endpoints\n"
"firewall. Path must be of the form 'file:///path/to/file'\n"
"or '/path/to/file'.\n"
"\n"
@@ -285,8 +285,8 @@ mesos::internal::master::Flags::Flags()
add(&Flags::rate_limits,
"rate_limits",
- "The value could be a JSON formatted string of rate limits\n"
- "or a file path containing the JSON formatted rate limits used\n"
+ "The value could be a JSON-formatted string of rate limits\n"
+ "or a file path containing the JSON-formatted rate limits used\n"
"for framework rate limiting.\n"
"Path could be of the form 'file:///path/to/file'\n"
"or '/path/to/file'.\n"
@@ -335,7 +335,7 @@ mesos::internal::master::Flags::Flags()
"subsystems.\n"
"\n"
"Use --modules=filepath to specify the list of modules via a\n"
- "file containing a JSON formatted string. 'filepath' can be\n"
+ "file containing a JSON-formatted string. 'filepath' can be\n"
"of the form 'file:///path/to/file' or '/path/to/file'.\n"
"\n"
"Use --modules=\"{...}\" to specify the list of modules inline.\n"
@@ -387,7 +387,7 @@ mesos::internal::master::Flags::Flags()
add(&Flags::hooks,
"hooks",
- "A comma separated list of hook modules to be\n"
+ "A comma-separated list of hook modules to be\n"
"installed inside master.");
add(&Flags::slave_ping_timeout,
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/src/slave/flags.cpp
----------------------------------------------------------------------
diff --git a/src/slave/flags.cpp b/src/slave/flags.cpp
index ed9b0b8..825b612 100644
--- a/src/slave/flags.cpp
+++ b/src/slave/flags.cpp
@@ -79,7 +79,7 @@ mesos::internal::slave::Flags::Flags()
add(&Flags::image_providers,
"image_providers",
- "Comma separated list of supported image providers,\n"
+ "Comma-separated list of supported image providers,\n"
"e.g., 'APPC,DOCKER'.");
add(&Flags::image_provisioner_backend,
@@ -350,8 +350,8 @@ mesos::internal::slave::Flags::Flags()
add(&Flags::firewall_rules,
"firewall_rules",
- "The value could be a JSON formatted string of rules or a\n"
- "file path containing the JSON formated rules used in the endpoints\n"
+ "The value could be a JSON-formatted string of rules or a\n"
+ "file path containing the JSON-formatted rules used in the endpoints\n"
"firewall. Path must be of the form 'file:///path/to/file'\n"
"or '/path/to/file'.\n"
"\n"
@@ -372,8 +372,8 @@ mesos::internal::slave::Flags::Flags()
"Either a path to a text with a single line\n"
"containing 'principal' and 'secret' separated by "
"whitespace.\n"
- "Or a path containing the JSON "
- "formatted information used for one credential.\n"
+ "Or a path containing the JSON-formatted "
+ "information used for one credential.\n"
"Path could be of the form 'file:///path/to/file' or '/path/to/file'."
"\n"
"Example:\n"
@@ -389,7 +389,7 @@ mesos::internal::slave::Flags::Flags()
add(&Flags::containerizers,
"containerizers",
- "Comma separated list of containerizer implementations\n"
+ "Comma-separated list of containerizer implementations\n"
"to compose in order to provide containerization.\n"
"Available options are 'mesos', 'external', and\n"
"'docker' (on Linux). The order the containerizers\n"
@@ -449,7 +449,7 @@ mesos::internal::slave::Flags::Flags()
add(&Flags::default_container_info,
"default_container_info",
- "JSON formatted ContainerInfo that will be included into\n"
+ "JSON-formatted ContainerInfo that will be included into\n"
"any ExecutorInfo that does not specify a ContainerInfo.\n"
"\n"
"See the ContainerInfo protobuf in mesos.proto for\n"
@@ -549,7 +549,7 @@ mesos::internal::slave::Flags::Flags()
"subsystems.\n"
"\n"
"Use --modules=filepath to specify the list of modules via a\n"
- "file containing a JSON formatted string. 'filepath' can be\n"
+ "file containing a JSON-formatted string. 'filepath' can be\n"
"of the form 'file:///path/to/file' or '/path/to/file'.\n"
"\n"
"Use --modules=\"{...}\" to specify the list of modules inline.\n"
@@ -596,7 +596,7 @@ mesos::internal::slave::Flags::Flags()
add(&Flags::hooks,
"hooks",
- "A comma separated list of hook modules to be\n"
+ "A comma-separated list of hook modules to be\n"
"installed inside the slave.");
add(&Flags::resource_estimator,
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/src/tests/flags.hpp
----------------------------------------------------------------------
diff --git a/src/tests/flags.hpp b/src/tests/flags.hpp
index 06da36d..984cd4a 100644
--- a/src/tests/flags.hpp
+++ b/src/tests/flags.hpp
@@ -96,7 +96,7 @@ public:
"subsystems.\n"
"\n"
"Use --modules=filepath to specify the list of modules via a\n"
- "file containing a JSON formatted string. 'filepath' can be\n"
+ "file containing a JSON-formatted string. 'filepath' can be\n"
"of the form 'file:///path/to/file' or '/path/to/file'.\n"
"\n"
"Use --modules=\"{...}\" to specify the list of modules inline.\n"
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/src/tests/repair_tests.cpp
----------------------------------------------------------------------
diff --git a/src/tests/repair_tests.cpp b/src/tests/repair_tests.cpp
index 4d513ed..a8d6c0d 100644
--- a/src/tests/repair_tests.cpp
+++ b/src/tests/repair_tests.cpp
@@ -187,7 +187,7 @@ TEST_F(HealthTest, ObserveEndpoint)
"monitor=a&hosts=b&level=true");
VALIDATE_GOOD_RESPONSE(response, stringify(expected) );
- // Comma seperated hosts are parsed into an array.
+ // Comma-separated hosts are parsed into an array.
expected.hosts.push_back("e");
response = process::http::post(
master.get(),
http://git-wip-us.apache.org/repos/asf/mesos/blob/249bc263/src/zookeeper/zookeeper.hpp
----------------------------------------------------------------------
diff --git a/src/zookeeper/zookeeper.hpp b/src/zookeeper/zookeeper.hpp
index c799506..0d8b354 100644
--- a/src/zookeeper/zookeeper.hpp
+++ b/src/zookeeper/zookeeper.hpp
@@ -117,7 +117,7 @@ public:
* establishment is asynchronous, meaning that the session should
* not be considered established until (and unless) an event of
* state ZOO_CONNECTED_STATE is received.
- * \param servers comma separated host:port pairs, each corresponding
+ * \param servers comma-separated host:port pairs, each corresponding
* to a ZooKeeper server. e.g. "127.0.0.1:3000,127.0.0.1:3001"
* \param watcher the instance of Watcher that receives event
* callbacks. When notifications are triggered the Watcher::process