From dbed0f7d6ab2d7f08a36eeb69748772387d58694 Mon Sep 17 00:00:00 2001 From: Cong Ding Date: Thu, 27 Feb 2014 10:59:54 -0800 Subject: [PATCH] fix(Documentation/*): fix various typos --- Documentation/api.md | 5 ++--- Documentation/configuration.md | 8 ++++---- Documentation/debugging.md | 4 ++-- Documentation/design/discovery.md | 2 +- Documentation/discovery-protocol.md | 2 +- Documentation/etcd-file-system.md | 2 +- Documentation/internal-protocol-versioning.md | 2 +- Documentation/platforms/freebsd.md | 8 ++++---- 8 files changed, 16 insertions(+), 17 deletions(-) diff --git a/Documentation/api.md b/Documentation/api.md index 19aa96ff2..ea55d3d51 100644 --- a/Documentation/api.md +++ b/Documentation/api.md @@ -21,7 +21,7 @@ The key space consists of directories and keys which are generically referred to ### Setting the value of a key -Let’s set the first key-value pair in the datastore. +Let's set the first key-value pair in the datastore. In this case the key is `/message` and the value is `Hello world`. ```sh @@ -122,7 +122,6 @@ curl -L http://127.0.0.1:4001/v2/keys/message -XPUT -d value="Hello etcd" "key": "/message", "value": "Hello world", "modifiedIndex": 2, - } } ``` @@ -1089,7 +1088,7 @@ Each node keeps a number of internal statistics: - `sendAppendRequestCnt`: number of requests that this node has sent - `sendBandwidthRate`: number of bytes per second this node is receiving (leader only). This value is undefined on single machine clusters. - `sendPkgRate`: number of requests per second this node is receiving (leader only). This value is undefined on single machine clusters. -- `state`: either leader or folower +- `state`: either leader or follower - `startTime`: the time when this node was started This is an example response from a follower machine: diff --git a/Documentation/configuration.md b/Documentation/configuration.md index 1ffb8f821..3569dc824 100644 --- a/Documentation/configuration.md +++ b/Documentation/configuration.md @@ -20,21 +20,21 @@ configuration files. * `-addr` - The advertised public hostname:port for client communication. Defaults to `127.0.0.1:4001`. * `-discovery` - A URL to use for discovering the peer list. (i.e `"https://discovery.etcd.io/your-unique-key"`). -* `-bind-addr` - The listening hostname for client communication. Defaults to advertised ip. +* `-bind-addr` - The listening hostname for client communication. Defaults to advertised IP. * `-peers` - A comma separated list of peers in the cluster (i.e `"203.0.113.101:7001,203.0.113.102:7001"`). * `-peers-file` - The file path containing a comma separated list of peers in the cluster. * `-ca-file` - The path of the client CAFile. Enables client cert authentication when present. * `-cert-file` - The cert file of the client. * `-key-file` - The key file of the client. -* `-config` - The path of the etcd config file. Defaults to `/etc/etcd/etcd.conf`. +* `-config` - The path of the etcd configuration file. Defaults to `/etc/etcd/etcd.conf`. * `-cors` - A comma separated white list of origins for cross-origin resource sharing. -* `-cpuprofile` - The path to a file to output cpu profile data. Enables cpu profiling when present. +* `-cpuprofile` - The path to a file to output CPU profile data. Enables CPU profiling when present. * `-data-dir` - The directory to store log and snapshot. Defaults to the current working directory. * `-max-result-buffer` - The max size of result buffer. Defaults to `1024`. * `-max-cluster-size` - The max size of the cluster. Defaults to `9`. * `-max-retry-attempts` - The max retry attempts when trying to join a cluster. Defaults to `3`. * `-peer-addr` - The advertised public hostname:port for server communication. Defaults to `127.0.0.1:7001`. -* `-peer-bind-addr` - The listening hostname for server communication. Defaults to advertised ip. +* `-peer-bind-addr` - The listening hostname for server communication. Defaults to advertised IP. * `-peer-ca-file` - The path of the CAFile. Enables client/peer cert authentication when present. * `-peer-cert-file` - The cert file of the server. * `-peer-key-file` - The key file of the server. diff --git a/Documentation/debugging.md b/Documentation/debugging.md index 86561a702..1e266b140 100644 --- a/Documentation/debugging.md +++ b/Documentation/debugging.md @@ -44,10 +44,10 @@ See an [example collectd deploy script](https://github.com/coreos/etcd/contrib/c ## Profiling etcd exposes profiling information from the Go pprof package over HTTP. -The basic browseable interface is served by etcd at the `/debug/pprof` HTTP endpoint (i.e. `http://127.0.0.1:4001/debug/pprof`). +The basic browsable interface is served by etcd at the `/debug/pprof` HTTP endpoint (i.e. `http://127.0.0.1:4001/debug/pprof`). For more information on using profiling tools, see http://blog.golang.org/profiling-go-programs. -**NOTE**: In the following examples you need to ensure that the `./bin/etcd` is identical to the `./bin/etcd` that you are targetting (same git hash, arch, platform, etc). +**NOTE**: In the following examples you need to ensure that the `./bin/etcd` is identical to the `./bin/etcd` that you are targeting (same git hash, arch, platform, etc). #### Heap memory profile diff --git a/Documentation/design/discovery.md b/Documentation/design/discovery.md index 18f49146b..237b30ddb 100644 --- a/Documentation/design/discovery.md +++ b/Documentation/design/discovery.md @@ -14,7 +14,7 @@ a new cluster. We assume the user doesn't want to start a brand new cluster with ## Logical Workflow -Start a etcd machine: +Start an etcd machine: ``` If discovery url is given: diff --git a/Documentation/discovery-protocol.md b/Documentation/discovery-protocol.md index 254532095..03be66802 100644 --- a/Documentation/discovery-protocol.md +++ b/Documentation/discovery-protocol.md @@ -20,7 +20,7 @@ UUID=$(uuidgen) Now that you have your cluster ID you can start bringing up machines. Every machine will follow this protocol internally in etcd if given a `-discovery`. -### Registering your Machine +### Registering your Machine The first thing etcd must do is register your machine. This is done by using the machine name (from the `-name` arg) and posting it with a long TTL to the given key. diff --git a/Documentation/etcd-file-system.md b/Documentation/etcd-file-system.md index cfd734432..f4ae09f1d 100644 --- a/Documentation/etcd-file-system.md +++ b/Documentation/etcd-file-system.md @@ -77,7 +77,7 @@ Unless overridden, a node naturally inherits the ACL names of its parent directo For each ACL name, it has three children: *R (Reading)*, *W (Writing)*, *C (Changing)* -Each permission is also a node. Under the node it contains the users who have this permission for the file refering to this ACL name. +Each permission is also a node. Under the node it contains the users who have this permission for the file referring to this ACL name. ### Example [TODO] diff --git a/Documentation/internal-protocol-versioning.md b/Documentation/internal-protocol-versioning.md index ec3874d25..6df1fd402 100644 --- a/Documentation/internal-protocol-versioning.md +++ b/Documentation/internal-protocol-versioning.md @@ -26,7 +26,7 @@ Advantages Disadvantages -- Follower knows better what versions of the interal protocol it can talk than the leader +- Follower knows better what versions of the internal protocol it can talk than the leader ### Follower Controlled diff --git a/Documentation/platforms/freebsd.md b/Documentation/platforms/freebsd.md index ee405ac68..13384db6f 100644 --- a/Documentation/platforms/freebsd.md +++ b/Documentation/platforms/freebsd.md @@ -26,7 +26,7 @@ coreos­etcdctl­0.2.0           Simple commandline client for et r@fbsd­10:/ # ``` -5. You’re ready to use etcd and etcdctl! For more information about using pkgng, plese +5. You’re ready to use etcd and etcdctl! For more information about using pkgng, please see: http://www.freebsd.org/doc/handbook/pkgng­intro.html   ### Using ports system @@ -37,7 +37,7 @@ may take some time depending on your hardware and network connection) 2. Build etcd with `cd /usr/ports/devel/etcd && make install clean`, you will get an option to build and install documentation and etcdctl with it. -3. If you havent install it with etcdctl, and you would like to install it later, you can build it +3. If you haven't installed it with etcdctl, and you would like to install it later, you can build it with `cd /usr/ports/devel/etcdctl && make install clean` 4. Verify successful installation with `pkg info | grep etcd` and you should get: @@ -55,8 +55,8 @@ please see: https://www.freebsd.org/doc/handbook/ports­using.html ## Issues -If you find any issues with the build/install procedure or you’ve found a problem that -you’ve verified is local to FreeBSD version only (for example, by not being able to +If you find any issues with the build/install procedure or you've found a problem that +you've verified is local to FreeBSD version only (for example, by not being able to reproduce it on any other platform, like OSX or Linux), please sent a problem report using this page for more information: http://www.freebsd.org/send­pr.html