Merge pull request #2165 from yichengq/312

docs: fix details about 2.0

Documentation/0_4_migration_tool.md

@@ -4,7 +4,7 @@
 
 Between 0.4.x and 2.0, the on-disk data formats have changed. In order to allow users to convert to 2.0, a migration tool is provided.
 
-In the early 2.0.0-alpha series, we're providing this tool early to encourage adoption. However, before 2.0.0-release, etcd will autodetect the 0.4.x data dir upon upgrade and automatically update the data too (while leaving a backup, in case of emergency).
+etcd will detect 0.4.x data dir and update the data automatically (while leaving a backup, in case of emergency).
 
 ### Data Migration Tips
 

Documentation/backward_compatibility.md

@@ -10,15 +10,17 @@ The major flag changes are to mostly related to bootstrapping. The `initial-*` f
 
  - `-addr` is replaced by `-advertise-client-urls`.
  - `-bind-addr` is replaced by `-listen-client-urls`.
- - `-peer-add` is replaced by `-initial-advertise-peer-urls`.
+ - `-peer-addr` is replaced by `-initial-advertise-peer-urls`.
  - `-peer-bind-addr` is replaced by `-listen-peer-urls`.
  - `-peers` is replaced by `-initial-cluster`.
  - `-peers-file` is replaced by `-initial-cluster`.
+ - `-peer-heartbeat-interval` is replaced by `-heartbeat-interval`.
+ - `-peer-election-timeout` is replaced by `-election-timeout`.
 
-The documentation of new command line flags can be found at 
+The documentation of new command line flags can be found at
 https://github.com/coreos/etcd/blob/master/Documentation/configuration.md.
 
-#### Data Dir 
+#### Data Dir
 - Default data dir location has changed from {$hostname}.etcd to {name}.etcd.
 
 - The disk format within the data dir has changed. etcd 2.0 should be able to auto upgrade the old data format. Instructions on doing so manually are in the [migration tool doc][migrationtooldoc].
@@ -27,7 +29,7 @@ https://github.com/coreos/etcd/blob/master/Documentation/configuration.md.
 
 #### Standby
 
-etcd 0.4’s standby mode has been deprecated by 2.0’s [proxy mode][proxymode]. 
+etcd 0.4’s standby mode has been deprecated. [Proxy mode][proxymode] is introduced to solve a subset of problems standby was solving.
 
 Standby mode was intended for large clusters that had a subset of the members acting in the consensus process. Overall this process was too magical and allowed for operators to back themselves into a corner.
 

Documentation/configuration.md

@@ -22,11 +22,11 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 + Number of committed transactions to trigger a snapshot to disk.
 + default: "10000"
 
-##### heartbeat-interval 
+##### -heartbeat-interval
 + Time (in milliseconds) of a heartbeat interval.
 + default: "100"
 
-##### election-timeout 
+##### -election-timeout
 + Time (in milliseconds) for an election to timeout.
 + default: "1000"
 
@@ -67,15 +67,15 @@ To start etcd automatically using custom settings at startup in Linux, using a [
 + Initial cluster configuration for bootstrapping.
 + default: "default=http://localhost:2380,default=http://localhost:7001"
 
-##### initial-cluster-state
+##### -initial-cluster-state
 + Initial cluster state ("new" or "existing").
 + default: "new"
 
-##### initial-cluster-token
+##### -initial-cluster-token
 + Initial cluster token for the etcd cluster during bootstrap.
 + default: "etcd-cluster"
 
-##### advertise-client-urls
+##### -advertise-client-urls
 + List of this member's client URLs to advertise to the rest of the cluster.
 + default: "http://localhost:2379,http://localhost:4001"
 

Documentation/production-ready.md

@@ -2,6 +2,3 @@ etcd is being used successfully by many companies in production. It is,
 however, under active development and systems like etcd are difficult to get
 correct. If you are comfortable with bleeding-edge software please use etcd and
 provide us with the feedback and testing young software needs.
-
-When the etcd team feels confident removing this warning we will release etcd
-1.0.

Documentation/tuning.md

@@ -32,23 +32,14 @@ You can override the default values on the command line:
 
 ```sh
 # Command line arguments:
-$ etcd -peer-heartbeat-interval=100 -peer-election-timeout=500
+$ etcd -heartbeat-interval=100 -election-timeout=500
 
 # Environment variables:
-$ ETCD_PEER_HEARTBEAT_INTERVAL=100 ETCD_PEER_ELECTION_TIMEOUT=500 etcd
-```
-
-Or you can set the values within the configuration file:
-
-```toml
-[peer]
-heartbeat_interval = 100
-election_timeout = 500
+$ ETCD_HEARTBEAT_INTERVAL=100 ETCD_ELECTION_TIMEOUT=500 etcd
 ```
 
 The values are specified in milliseconds.
 
-
 ### Snapshots
 
 etcd appends all key changes to a log file.
@@ -72,12 +63,6 @@ $ etcd -snapshot-count=5000
 $ ETCD_SNAPSHOT_COUNT=5000 etcd
 ```
 
-Or you can change the setting in the configuration file:
-
-```toml
-snapshot_count = 5000
-```
-
 You can also disable snapshotting by adding the following to your command line:
 
 ```sh
@@ -87,9 +72,3 @@ $ etcd -snapshot false
 # Environment variables:
 $ ETCD_SNAPSHOT=false etcd
 ```
-
-You can also disable snapshotting within the configuration file:
-
-```toml
-snapshot = false
-```