From 52782cf8eef191bef0c292b50b1abf1e40dc5fc1 Mon Sep 17 00:00:00 2001 From: Gyu-Ho Lee Date: Sun, 25 Oct 2015 06:31:37 -0700 Subject: [PATCH] etcdmain: make flags and formats idential This makes flagsline and config.go identical in its flag description and some punctuation conventions. --- etcdmain/config.go | 48 +++++++++++++++++++++++----------------------- etcdmain/help.go | 6 ++++-- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/etcdmain/config.go b/etcdmain/config.go index 0bb9d59fd..29639a5f9 100644 --- a/etcdmain/config.go +++ b/etcdmain/config.go @@ -151,36 +151,36 @@ func NewConfig() *config { // member fs.Var(cfg.corsInfo, "cors", "Comma-separated white list of origins for CORS (cross-origin resource sharing).") - fs.StringVar(&cfg.dir, "data-dir", "", "Path to the data directory") - fs.StringVar(&cfg.walDir, "wal-dir", "", "Path to the dedicated wal directory") - fs.Var(flags.NewURLsValue("http://localhost:2380,http://localhost:7001"), "listen-peer-urls", "List of URLs to listen on for peer traffic") - fs.Var(flags.NewURLsValue("http://localhost:2379,http://localhost:4001"), "listen-client-urls", "List of URLs to listen on for client traffic") - fs.UintVar(&cfg.maxSnapFiles, "max-snapshots", defaultMaxSnapshots, "Maximum number of snapshot files to retain (0 is unlimited)") - fs.UintVar(&cfg.maxWalFiles, "max-wals", defaultMaxWALs, "Maximum number of wal files to retain (0 is unlimited)") - fs.StringVar(&cfg.name, "name", defaultName, "Unique human-readable name for this node") - fs.Uint64Var(&cfg.snapCount, "snapshot-count", etcdserver.DefaultSnapCount, "Number of committed transactions to trigger a snapshot") + fs.StringVar(&cfg.dir, "data-dir", "", "Path to the data directory.") + fs.StringVar(&cfg.walDir, "wal-dir", "", "Path to the dedicated wal directory.") + fs.Var(flags.NewURLsValue("http://localhost:2380,http://localhost:7001"), "listen-peer-urls", "List of URLs to listen on for peer traffic.") + fs.Var(flags.NewURLsValue("http://localhost:2379,http://localhost:4001"), "listen-client-urls", "List of URLs to listen on for client traffic.") + fs.UintVar(&cfg.maxSnapFiles, "max-snapshots", defaultMaxSnapshots, "Maximum number of snapshot files to retain (0 is unlimited).") + fs.UintVar(&cfg.maxWalFiles, "max-wals", defaultMaxWALs, "Maximum number of wal files to retain (0 is unlimited).") + fs.StringVar(&cfg.name, "name", defaultName, "Unique human-readable name for this node.") + fs.Uint64Var(&cfg.snapCount, "snapshot-count", etcdserver.DefaultSnapCount, "Number of committed transactions to trigger a snapshot.") fs.UintVar(&cfg.TickMs, "heartbeat-interval", 100, "Time (in milliseconds) of a heartbeat interval.") fs.UintVar(&cfg.ElectionMs, "election-timeout", 1000, "Time (in milliseconds) for an election to timeout.") // clustering - fs.Var(flags.NewURLsValue(defaultInitialAdvertisePeerURLs), "initial-advertise-peer-urls", "List of this member's peer URLs to advertise to the rest of the cluster") - fs.Var(flags.NewURLsValue("http://localhost:2379,http://localhost:4001"), "advertise-client-urls", "List of this member's client URLs to advertise to the rest of the cluster") - fs.StringVar(&cfg.durl, "discovery", "", "Discovery service used to bootstrap the initial cluster") + fs.Var(flags.NewURLsValue(defaultInitialAdvertisePeerURLs), "initial-advertise-peer-urls", "List of this member's peer URLs to advertise to the rest of the cluster.") + fs.Var(flags.NewURLsValue("http://localhost:2379,http://localhost:4001"), "advertise-client-urls", "List of this member's client URLs to advertise to the rest of the cluster.") + fs.StringVar(&cfg.durl, "discovery", "", "Discovery service used to bootstrap the initial cluster.") fs.Var(cfg.fallback, "discovery-fallback", fmt.Sprintf("Valid values include %s", strings.Join(cfg.fallback.Values, ", "))) if err := cfg.fallback.Set(fallbackFlagProxy); err != nil { // Should never happen. plog.Panicf("unexpected error setting up discovery-fallback flag: %v", err) } - fs.StringVar(&cfg.dproxy, "discovery-proxy", "", "HTTP proxy to use for traffic to discovery service") - fs.StringVar(&cfg.dnsCluster, "discovery-srv", "", "DNS domain used to bootstrap initial cluster") - fs.StringVar(&cfg.initialCluster, "initial-cluster", initialClusterFromName(defaultName), "Initial cluster configuration for bootstrapping") - fs.StringVar(&cfg.initialClusterToken, "initial-cluster-token", "etcd-cluster", "Initial cluster token for the etcd cluster during bootstrap") - fs.Var(cfg.clusterState, "initial-cluster-state", "Initial cluster configuration for bootstrapping") + fs.StringVar(&cfg.dproxy, "discovery-proxy", "", "HTTP proxy to use for traffic to discovery service.") + fs.StringVar(&cfg.dnsCluster, "discovery-srv", "", "DNS domain used to bootstrap initial cluster.") + fs.StringVar(&cfg.initialCluster, "initial-cluster", initialClusterFromName(defaultName), "Initial cluster configuration for bootstrapping.") + fs.StringVar(&cfg.initialClusterToken, "initial-cluster-token", "etcd-cluster", "Initial cluster token for the etcd cluster during bootstrap.") + fs.Var(cfg.clusterState, "initial-cluster-state", "Initial cluster configuration for bootstrapping.") if err := cfg.clusterState.Set(clusterStateFlagNew); err != nil { // Should never happen. plog.Panicf("unexpected error setting up clusterStateFlag: %v", err) } - fs.BoolVar(&cfg.strictReconfigCheck, "strict-reconfig-check", false, "Reject reconfiguration that might cause quorum loss") + fs.BoolVar(&cfg.strictReconfigCheck, "strict-reconfig-check", false, "Reject reconfiguration that might cause quorum loss.") // proxy fs.Var(cfg.proxy, "proxy", fmt.Sprintf("Valid values include %s", strings.Join(cfg.proxy.Values, ", "))) @@ -208,25 +208,25 @@ func NewConfig() *config { // logging fs.BoolVar(&cfg.debug, "debug", false, "Enable debug output to the logs.") - fs.StringVar(&cfg.logPkgLevels, "log-package-levels", "", "Specify a particular log level for each etcd package.") + fs.StringVar(&cfg.logPkgLevels, "log-package-levels", "", "Specify a particular log level for each etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG').") // unsafe - fs.BoolVar(&cfg.forceNewCluster, "force-new-cluster", false, "Force to create a new one member cluster") + fs.BoolVar(&cfg.forceNewCluster, "force-new-cluster", false, "Force to create a new one member cluster.") // version - fs.BoolVar(&cfg.printVersion, "version", false, "Print the version and exit") + fs.BoolVar(&cfg.printVersion, "version", false, "Print the version and exit.") // demo flag - fs.BoolVar(&cfg.v3demo, "experimental-v3demo", false, "Enable experimental v3 demo API") - fs.StringVar(&cfg.gRPCAddr, "experimental-gRPC-addr", "127.0.0.1:2378", "gRPC address for experimental v3 demo API") + fs.BoolVar(&cfg.v3demo, "experimental-v3demo", false, "Enable experimental v3 demo API.") + fs.StringVar(&cfg.gRPCAddr, "experimental-gRPC-addr", "127.0.0.1:2378", "gRPC address for experimental v3 demo API.") // backwards-compatibility with v0.4.6 fs.Var(&flags.IPAddressPort{}, "addr", "DEPRECATED: Use -advertise-client-urls instead.") fs.Var(&flags.IPAddressPort{}, "bind-addr", "DEPRECATED: Use -listen-client-urls instead.") fs.Var(&flags.IPAddressPort{}, "peer-addr", "DEPRECATED: Use -initial-advertise-peer-urls instead.") fs.Var(&flags.IPAddressPort{}, "peer-bind-addr", "DEPRECATED: Use -listen-peer-urls instead.") - fs.Var(&flags.DeprecatedFlag{Name: "peers"}, "peers", "DEPRECATED: Use -initial-cluster instead") - fs.Var(&flags.DeprecatedFlag{Name: "peers-file"}, "peers-file", "DEPRECATED: Use -initial-cluster instead") + fs.Var(&flags.DeprecatedFlag{Name: "peers"}, "peers", "DEPRECATED: Use -initial-cluster instead.") + fs.Var(&flags.DeprecatedFlag{Name: "peers-file"}, "peers-file", "DEPRECATED: Use -initial-cluster instead.") // ignored for _, f := range cfg.ignored { diff --git a/etcdmain/help.go b/etcdmain/help.go index 312bf94f7..80c03dc63 100644 --- a/etcdmain/help.go +++ b/etcdmain/help.go @@ -114,7 +114,7 @@ logging flags --debug 'false' enable debug-level logging for etcd. --log-package-levels '' - set individual packages to various log levels (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG') + specify a particular log level for each etcd package (eg: 'etcdmain=CRITICAL,etcdserver=DEBUG'). unsafe flags: @@ -128,6 +128,8 @@ given by the consensus protocol. experimental flags: --experimental-v3demo 'false' - enable experimental v3 demo API + enable experimental v3 demo API. + --experimental-gRPC-addr '127.0.0.1:2378' + gRPC address for experimental v3 demo API. ` )