Merge pull request #2231 from rht/docs/punc-caps

Fix punc-caps issues of cli Tagline

cmd/ipfs/daemon.go

@@ -44,7 +44,7 @@ const (
 
 var daemonCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Run a network-connected IPFS node",
+		Tagline: "Run a network-connected IPFS node.",
 		ShortDescription: `
 'ipfs daemon' runs a persistent IPFS daemon that can serve commands
 over the network. Most applications that use IPFS will do so by

cmd/ipfs/init.go

@@ -20,7 +20,7 @@ const nBitsForKeypairDefault = 2048
 
 var initCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Initializes IPFS config file",
+		Tagline: "Initializes IPFS config file.",
 		ShortDescription: `
 Initializes IPFS configuration files and generates a new keypair.
 

core/commands/block.go

@@ -26,7 +26,7 @@ func (bs BlockStat) String() string {
 
 var BlockCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Manipulate raw IPFS blocks",
+		Tagline: "Manipulate raw IPFS blocks.",
 		ShortDescription: `
 'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
 Reads from stdin or writes to stdout, and <key> is a base58 encoded
@@ -43,7 +43,7 @@ multihash.
 
 var blockStatCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Print information of a raw IPFS block",
+		Tagline: "Print information of a raw IPFS block.",
 		ShortDescription: `
 'ipfs block stat' is a plumbing command for retreiving information
 on raw ipfs blocks. It outputs the following to stdout:
@@ -80,7 +80,7 @@ on raw ipfs blocks. It outputs the following to stdout:
 
 var blockGetCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Get a raw IPFS block",
+		Tagline: "Get a raw IPFS block.",
 		ShortDescription: `
 'ipfs block get' is a plumbing command for retreiving raw ipfs blocks.
 It outputs to stdout, and <key> is a base58 encoded multihash.
@@ -103,7 +103,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.
 
 var blockPutCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Stores input as an IPFS block",
+		Tagline: "Stores input as an IPFS block.",
 		ShortDescription: `
 ipfs block put is a plumbing command for storing raw ipfs blocks.
 It reads from stdin, and <key> is a base58 encoded multihash.

core/commands/bootstrap.go

@@ -21,7 +21,7 @@ var peerOptionDesc = "A peer to add to the bootstrap list (in the format '<multi
 
 var BootstrapCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Show or edit the list of bootstrap peers",
+		Tagline: "Show or edit the list of bootstrap peers.",
 		Synopsis: `
 ipfs bootstrap list             - Show peers in the bootstrap list
 ipfs bootstrap add <peer>...    - Add peers to the bootstrap list
@@ -45,7 +45,7 @@ Running 'ipfs bootstrap' with no arguments will run 'ipfs bootstrap list'.
 
 var bootstrapAddCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Add peers to the bootstrap list",
+		Tagline: "Add peers to the bootstrap list.",
 		ShortDescription: `Outputs a list of peers that were added (that weren't already
 in the bootstrap list).
 ` + bootstrapSecurityWarning,
@@ -128,7 +128,7 @@ in the bootstrap list).
 
 var bootstrapRemoveCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Removes peers from the bootstrap list",
+		Tagline: "Removes peers from the bootstrap list.",
 		ShortDescription: `Outputs the list of peers that were removed.
 ` + bootstrapSecurityWarning,
 	},
@@ -194,7 +194,7 @@ var bootstrapRemoveCmd = &cmds.Command{
 
 var bootstrapListCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Show peers in the bootstrap list",
+		Tagline:          "Show peers in the bootstrap list.",
 		ShortDescription: "Peers are output in the format '<multiaddr>/<peerID>'.",
 	},
 

core/commands/cat.go

@@ -15,7 +15,7 @@ const progressBarMinSize = 1024 * 1024 * 8 // show progress bar for outputs > 8M
 
 var CatCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Show IPFS object data",
+		Tagline: "Show IPFS object data.",
 		ShortDescription: `
 Retrieves the object named by <ipfs-or-ipns-path> and outputs the data
 it contains.

core/commands/config.go

@@ -24,7 +24,7 @@ type ConfigField struct {
 
 var ConfigCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "get and set IPFS config values",
+		Tagline: "Get and set IPFS config values.",
 		Synopsis: `
 ipfs config <key>          - Get value of <key>
 ipfs config <key> <value>  - Set value of <key> to <value>
@@ -133,7 +133,7 @@ Set the value of the 'datastore.path' key:
 
 var configShowCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Outputs the content of the config file",
+		Tagline: "Outputs the content of the config file.",
 		ShortDescription: `
 WARNING: Your private key is stored in the config file, and it will be
 included in the output of this command.
@@ -158,7 +158,7 @@ included in the output of this command.
 
 var configEditCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Opens the config file for editing in $EDITOR",
+		Tagline: "Opens the config file for editing in $EDITOR.",
 		ShortDescription: `
 To use 'ipfs config edit', you must have the $EDITOR environment
 variable set to your preferred text editor.
@@ -181,7 +181,7 @@ variable set to your preferred text editor.
 
 var configReplaceCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Replaces the config with <file>",
+		Tagline: "Replaces the config with <file>.",
 		ShortDescription: `
 Make sure to back up the config file first if neccessary, this operation
 can't be undone.

core/commands/dht.go

@@ -20,7 +20,7 @@ var ErrNotDHT = errors.New("routing service is not a DHT")
 
 var DhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Issue commands directly through the DHT",
+		Tagline:          "Issue commands directly through the DHT.",
 		ShortDescription: ``,
 	},
 
@@ -35,7 +35,7 @@ var DhtCmd = &cmds.Command{
 
 var queryDhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Run a 'findClosestPeers' query through the DHT",
+		Tagline:          "Run a 'findClosestPeers' query through the DHT.",
 		ShortDescription: ``,
 	},
 
@@ -119,7 +119,7 @@ var queryDhtCmd = &cmds.Command{
 
 var findProvidersDhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Run a 'FindProviders' query through the DHT",
+		Tagline: "Run a 'FindProviders' query through the DHT.",
 		ShortDescription: `
 FindProviders will return a list of peers who are able to provide the value requested.
 `,
@@ -222,7 +222,7 @@ FindProviders will return a list of peers who are able to provide the value requ
 
 var findPeerDhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Run a 'FindPeer' query through the DHT",
+		Tagline:          "Run a 'FindPeer' query through the DHT.",
 		ShortDescription: ``,
 	},
 
@@ -317,7 +317,7 @@ var findPeerDhtCmd = &cmds.Command{
 
 var getValueDhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Run a 'GetValue' query through the DHT",
+		Tagline: "Run a 'GetValue' query through the DHT.",
 		ShortDescription: `
 GetValue will return the value stored in the dht at the given key.
 `,
@@ -420,7 +420,7 @@ GetValue will return the value stored in the dht at the given key.
 
 var putValueDhtCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Run a 'PutValue' query through the DHT",
+		Tagline: "Run a 'PutValue' query through the DHT.",
 		ShortDescription: `
 PutValue will store the given key value pair in the dht.
 `,

core/commands/diag.go

@@ -41,7 +41,7 @@ var DefaultDiagnosticTimeout = time.Second * 20
 
 var DiagCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Generates diagnostic reports",
+		Tagline: "Generates diagnostic reports.",
 	},
 
 	Subcommands: map[string]*cmds.Command{
@@ -52,7 +52,7 @@ var DiagCmd = &cmds.Command{
 
 var diagNetCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Generates a network diagnostics report",
+		Tagline: "Generates a network diagnostics report.",
 		ShortDescription: `
 Sends out a message to each node in the network recursively
 requesting a listing of data about them including number of

core/commands/dns.go

@@ -11,7 +11,7 @@ import (
 
 var DNSCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "DNS link resolver",
+		Tagline: "DNS link resolver.",
 		ShortDescription: `
 Multihashes are hard to remember, but domain names are usually easy to
 remember.  To create memorable aliases for multihashes, DNS TXT

core/commands/files/files.go

@@ -24,7 +24,7 @@ var log = logging.Logger("cmds/files")
 
 var FilesCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Manipulate unixfs files",
+		Tagline: "Manipulate unixfs files.",
 		ShortDescription: `
 Files is an API for manipulating ipfs objects as if they were a unix filesystem.
 `,
@@ -46,7 +46,7 @@ Files is an API for manipulating ipfs objects as if they were a unix filesystem.
 
 var FilesStatCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "display file status",
+		Tagline: "Display file status.",
 	},
 
 	Arguments: []cmds.Argument{
@@ -137,7 +137,7 @@ func statNode(ds dag.DAGService, fsn mfs.FSNode) (*Object, error) {
 
 var FilesCpCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "copy files into mfs",
+		Tagline: "Copy files into mfs.",
 	},
 	Arguments: []cmds.Argument{
 		cmds.StringArg("source", true, false, "source object to copy"),
@@ -208,7 +208,7 @@ type FilesLsOutput struct {
 
 var FilesLsCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "List directories",
+		Tagline: "List directories.",
 		ShortDescription: `
 List directories.
 
@@ -310,7 +310,7 @@ Examples:
 
 var FilesReadCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Read a file in a given mfs",
+		Tagline: "Read a file in a given mfs.",
 		ShortDescription: `
 Read a specified number of bytes from a file at a given offset. By default, will
 read the entire file similar to unix cat.
@@ -400,7 +400,7 @@ Examples:
 
 var FilesMvCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Move files",
+		Tagline: "Move files.",
 		ShortDescription: `
 Move files around. Just like traditional unix mv.
 
@@ -443,7 +443,7 @@ Example:
 
 var FilesWriteCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Write to a mutable file in a given filesystem",
+		Tagline: "Write to a mutable file in a given filesystem.",
 		ShortDescription: `
 Write data to a file in a given filesystem. This command allows you to specify
 a beginning offset to write to. The entire length of the input will be written.
@@ -566,7 +566,7 @@ Warning:
 
 var FilesMkdirCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "make directories",
+		Tagline: "Make directories.",
 		ShortDescription: `
 Create the directory if it does not already exist.
 
@@ -615,7 +615,7 @@ Examples:
 
 var FilesRmCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "remove a file",
+		Tagline: "Remove a file.",
 		ShortDescription: `
 remove files or directories
 

core/commands/get.go

@@ -22,7 +22,7 @@ var ErrInvalidCompressionLevel = errors.New("Compression level must be between 1
 
 var GetCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Download IPFS objects",
+		Tagline: "Download IPFS objects.",
 		ShortDescription: `
 Retrieves the object named by <ipfs-or-ipns-path> and stores the data to disk.
 

core/commands/id.go

@@ -36,7 +36,7 @@ type IdOutput struct {
 
 var IDCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Show IPFS Node ID info",
+		Tagline: "Show IPFS Node ID info.",
 		ShortDescription: `
 Prints out information about the specified peer,
 if no peer is specified, prints out local peers info.

core/commands/ipns.go

@@ -13,7 +13,7 @@ import (
 
 var IpnsCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Gets the value currently published at an IPNS name",
+		Tagline: "Gets the value currently published at an IPNS name.",
 		ShortDescription: `
 IPNS is a PKI namespace, where names are the hashes of public keys, and
 the private key enables publishing new (signed) values. In resolve, the

core/commands/log.go

@@ -16,7 +16,7 @@ var logAllKeyword = "all"
 
 var LogCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Interact with the daemon log output",
+		Tagline: "Interact with the daemon log output.",
 		ShortDescription: `
 'ipfs log' contains utility commands to affect or read the logging
 output of a running daemon.
@@ -31,7 +31,7 @@ output of a running daemon.
 
 var logLevelCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Change the logging level",
+		Tagline: "Change the logging level.",
 		ShortDescription: `
 'ipfs log level' is a utility command used to change the logging
 output of a running daemon.
@@ -70,7 +70,7 @@ output of a running daemon.
 
 var logTailCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Read the logs",
+		Tagline: "Read the logs.",
 		ShortDescription: `
 'ipfs log tail' is a utility command used to read log output as it is written.
 `,

core/commands/mount_nofuse.go

@@ -12,7 +12,7 @@ import (
 
 var MountCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Mounts IPFS to the filesystem (disabled)",
+		Tagline: "Mounts IPFS to the filesystem (disabled).",
 		ShortDescription: `
 This version of ipfs is compiled without fuse support, which is required
 for mounting. If you'd like to be able to mount, please use a version of

core/commands/mount_unix.go

@@ -35,7 +35,7 @@ var platformFuseChecks = func(*core.IpfsNode) error {
 
 var MountCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Mounts IPFS to the filesystem (read-only)",
+		Tagline: "Mounts IPFS to the filesystem (read-only).",
 		Synopsis: `
 ipfs mount [-f <ipfs mount path>] [-n <ipns mount path>]
 `,

core/commands/mount_windows.go

@@ -9,7 +9,7 @@ import (
 
 var MountCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Not yet implemented on Windows",
+		Tagline:          "Not yet implemented on Windows.",
 		ShortDescription: "Not yet implemented on Windows. :(",
 	},
 

core/commands/name.go

@@ -9,7 +9,7 @@ type IpnsEntry struct {
 
 var NameCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "IPFS namespace (IPNS) tool",
+		Tagline: "IPFS namespace (IPNS) tool.",
 		Synopsis: `
 ipfs name publish [<name>] <ipfs-path> - Publish an object to IPNS
 ipfs name resolve [<name>]             - Gets the value currently published at an IPNS name