opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-09-10 11:52:21 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #2244 from ipfs/feature/capitalize-and-periods

Browse Source 
Capitalized beginning of line messages, added periods
This commit is contained in:
Jeromy Johnson
2016-01-26 22:31:02 -08:00
parent 8ef5a1084f 28fe2e4f4c
commit 8207fa7d07
32 changed files with 121 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
cmd/ipfs/init.go
View File

@ -35,13 +35,13 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
Options: []cmds.Option{
cmds.IntOption("bits", "b", fmt.Sprintf("Number of bits to use in the generated RSA private key (defaults to %d)", nBitsForKeypairDefault)),
cmds.BoolOption("force", "f", "Overwrite existing config (if it exists)"),
cmds.BoolOption("empty-repo", "e", "Don't add and pin help files to the local storage"),
cmds.BoolOption("force", "f", "Overwrite existing config (if it exists)."),
cmds.BoolOption("empty-repo", "e", "Don't add and pin help files to the local storage."),
// TODO need to decide whether to expose the override as a file or a
// directory. That is: should we allow the user to also specify the
// name of the file?
// TODO cmds.StringOption("event-logs", "l", "Location for machine-readable event logs"),
// TODO cmds.StringOption("event-logs", "l", "Location for machine-readable event logs."),
},
PreRun: func(req cmds.Request) error {
daemonLocked, err := fsrepo.LockedByOtherProcess(req.InvocContext().ConfigRoot)

2
core/commands/add.go
View File

@ -39,7 +39,7 @@ MerkleDAG.
},
Arguments: []cmds.Argument{
cmds.FileArg("path", true, true, "The path to a file to be added to IPFS").EnableRecursive().EnableStdin(),
cmds.FileArg("path", true, true, "The path to a file to be added to IPFS.").EnableRecursive().EnableStdin(),
},
Options: []cmds.Option{
cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)

6
core/commands/block.go
View File

@ -55,7 +55,7 @@ on raw ipfs blocks. It outputs the following to stdout:
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get").EnableStdin(),
cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
b, err := getBlockForKey(req, req.Arguments()[0])
@ -88,7 +88,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get").EnableStdin(),
cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
b, err := getBlockForKey(req, req.Arguments()[0])
@ -111,7 +111,7 @@ It reads from stdin, and <key> is a base58 encoded multihash.
},
Arguments: []cmds.Argument{
cmds.FileArg("data", true, false, "The data to be stored as an IPFS block").EnableStdin(),
cmds.FileArg("data", true, false, "The data to be stored as an IPFS block.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()

2
core/commands/bootstrap.go
View File

@ -56,7 +56,7 @@ in the bootstrap list).
},
Options: []cmds.Option{
cmds.BoolOption("default", "add default bootstrap nodes"),
cmds.BoolOption("default", "Add default bootstrap nodes."),
},
Run: func(req cmds.Request, res cmds.Response) {

2
core/commands/cat.go
View File

@ -23,7 +23,7 @@ it contains.
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to be outputted").EnableStdin(),
cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to be outputted.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode()

10
core/commands/config.go
View File

@ -54,12 +54,12 @@ Set the value of the 'datastore.path' key:
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "The key of the config entry (e.g. \"Addresses.API\")"),
cmds.StringArg("value", false, false, "The value to set the config entry to"),
cmds.StringArg("key", true, false, "The key of the config entry (e.g. \"Addresses.API\")."),
cmds.StringArg("value", false, false, "The value to set the config entry to."),
},
Options: []cmds.Option{
cmds.BoolOption("bool", "Set a boolean value"),
cmds.BoolOption("json", "Parse stringified JSON"),
cmds.BoolOption("bool", "Set a boolean value."),
cmds.BoolOption("json", "Parse stringified JSON."),
},
Run: func(req cmds.Request, res cmds.Response) {
args := req.Arguments()
@ -189,7 +189,7 @@ can't be undone.
},
Arguments: []cmds.Argument{
cmds.FileArg("file", true, false, "The file to use as the new config"),
cmds.FileArg("file", true, false, "The file to use as the new config."),
},
Run: func(req cmds.Request, res cmds.Response) {
r, err := fsrepo.Open(req.InvocContext().ConfigRoot)

20
core/commands/dht.go
View File

@ -40,10 +40,10 @@ var queryDhtCmd = &cmds.Command{
},
Arguments: []cmds.Argument{
cmds.StringArg("peerID", true, true, "The peerID to run the query against"),
cmds.StringArg("peerID", true, true, "The peerID to run the query against."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Write extra information"),
cmds.BoolOption("verbose", "v", "Write extra information."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -126,10 +126,10 @@ FindProviders will return a list of peers who are able to provide the value requ
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, true, "The key to find providers for"),
cmds.StringArg("key", true, true, "The key to find providers for."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Write extra information"),
cmds.BoolOption("verbose", "v", "Write extra information."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -227,7 +227,7 @@ var findPeerDhtCmd = &cmds.Command{
},
Arguments: []cmds.Argument{
cmds.StringArg("peerID", true, true, "The peer to search for"),
cmds.StringArg("peerID", true, true, "The peer to search for."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -324,10 +324,10 @@ GetValue will return the value stored in the dht at the given key.
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, true, "The key to find a value for"),
cmds.StringArg("key", true, true, "The key to find a value for."),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Write extra information"),
cmds.BoolOption("verbose", "v", "Write extra information."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -427,11 +427,11 @@ PutValue will store the given key value pair in the dht.
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "The key to store the value at"),
cmds.StringArg("value", true, false, "The value to store").EnableStdin(),
cmds.StringArg("key", true, false, "The key to store the value at."),
cmds.StringArg("value", true, false, "The value to store.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Write extra information"),
cmds.BoolOption("verbose", "v", "Write extra information."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()

2
core/commands/diag.go
View File

@ -86,7 +86,7 @@ that consume the dot format to generate graphs of the network.
},
Options: []cmds.Option{
cmds.StringOption("vis", "output vis. one of: "+strings.Join(visFmts, ", ")),
cmds.StringOption("vis", "Output vis. one of: "+strings.Join(visFmts, ", ")),
},
Run: func(req cmds.Request, res cmds.Response) {

2
core/commands/dns.go
View File

@ -50,7 +50,7 @@ The resolver will give:
cmds.StringArg("domain-name", true, false, "The domain-name name to resolve.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("recursive", "r", "Resolve until the result is not a DNS link"),
cmds.BoolOption("recursive", "r", "Resolve until the result is not a DNS link."),
},
Run: func(req cmds.Request, res cmds.Response) {

2
core/commands/external.go
View File

@ -14,7 +14,7 @@ import (
func ExternalBinary() *cmds.Command {
return &cmds.Command{
Arguments: []cmds.Argument{
cmds.StringArg("args", false, true, "arguments for subcommand"),
cmds.StringArg("args", false, true, "Arguments for subcommand."),
},
External: true,
Run: func(req cmds.Request, res cmds.Response) {

42
core/commands/files/files.go
View File

@ -30,7 +30,7 @@ Files is an API for manipulating ipfs objects as if they were a unix filesystem.
`,
},
Options: []cmds.Option{
cmds.BoolOption("f", "flush", "flush target and ancestors after write (default: true)"),
cmds.BoolOption("f", "flush", "Flush target and ancestors after write (default: true)."),
},
Subcommands: map[string]*cmds.Command{
"read": FilesReadCmd,
@ -50,7 +50,7 @@ var FilesStatCmd = &cmds.Command{
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "path to node to stat"),
cmds.StringArg("path", true, false, "Path to node to stat."),
},
Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode()
@ -140,8 +140,8 @@ var FilesCpCmd = &cmds.Command{
Tagline: "Copy files into mfs.",
},
Arguments: []cmds.Argument{
cmds.StringArg("source", true, false, "source object to copy"),
cmds.StringArg("dest", true, false, "destination to copy object to"),
cmds.StringArg("source", true, false, "Source object to copy."),
cmds.StringArg("dest", true, false, "Destination to copy object to."),
},
Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode()
@ -228,10 +228,10 @@ Examples:
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "path to show listing for"),
cmds.StringArg("path", true, false, "Path to show listing for."),
},
Options: []cmds.Option{
cmds.BoolOption("l", "use long listing format"),
cmds.BoolOption("l", "Use long listing format."),
},
Run: func(req cmds.Request, res cmds.Response) {
path, err := checkPath(req.Arguments()[0])
@ -323,11 +323,11 @@ Examples:
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "path to file to be read"),
cmds.StringArg("path", true, false, "Path to file to be read."),
},
Options: []cmds.Option{
cmds.IntOption("o", "offset", "offset to read from"),
cmds.IntOption("n", "count", "maximum number of bytes to read"),
cmds.IntOption("o", "offset", "Offset to read from."),
cmds.IntOption("n", "count", "Maximum number of bytes to read."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -412,8 +412,8 @@ Example:
},
Arguments: []cmds.Argument{
cmds.StringArg("source", true, false, "source file to move"),
cmds.StringArg("dest", true, false, "target path for file to be moved to"),
cmds.StringArg("source", true, false, "Source file to move."),
cmds.StringArg("dest", true, false, "Target path for file to be moved to."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -468,14 +468,14 @@ Warning:
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "path to write to"),
cmds.FileArg("data", true, false, "data to write").EnableStdin(),
cmds.StringArg("path", true, false, "Path to write to."),
cmds.FileArg("data", true, false, "Data to write.").EnableStdin(),
},
Options: []cmds.Option{
cmds.IntOption("o", "offset", "offset to write to"),
cmds.BoolOption("e", "create", "create the file if it does not exist"),
cmds.BoolOption("t", "truncate", "truncate the file before writing"),
cmds.IntOption("n", "count", "maximum number of bytes to read"),
cmds.IntOption("o", "offset", "Offset to write to."),
cmds.BoolOption("e", "create", "Create the file if it does not exist."),
cmds.BoolOption("t", "truncate", "Truncate the file before writing."),
cmds.IntOption("n", "count", "Maximum number of bytes to read."),
},
Run: func(req cmds.Request, res cmds.Response) {
path, err := checkPath(req.Arguments()[0])
@ -580,10 +580,10 @@ Examples:
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "path to dir to make"),
cmds.StringArg("path", true, false, "Path to dir to make."),
},
Options: []cmds.Option{
cmds.BoolOption("p", "parents", "no error if existing, make parent directories as needed"),
cmds.BoolOption("p", "parents", "No error if existing, make parent directories as needed."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -629,10 +629,10 @@ remove files or directories
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, true, "file to remove"),
cmds.StringArg("path", true, true, "File to remove."),
},
Options: []cmds.Option{
cmds.BoolOption("r", "recursive", "recursively remove directories"),
cmds.BoolOption("r", "recursive", "Recursively remove directories."),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()

10
core/commands/get.go
View File

@ -37,13 +37,13 @@ may also specify the level of compression by specifying '-l=<1-9>'.
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, false, "The path to the IPFS object(s) to be outputted").EnableStdin(),
cmds.StringArg("ipfs-path", true, false, "The path to the IPFS object(s) to be outputted.").EnableStdin(),
},
Options: []cmds.Option{
cmds.StringOption("output", "o", "The path where output should be stored"),
cmds.BoolOption("archive", "a", "Output a TAR archive"),
cmds.BoolOption("compress", "C", "Compress the output with GZIP compression"),
cmds.IntOption("compression-level", "l", "The level of compression (1-9)"),
cmds.StringOption("output", "o", "The path where output should be stored."),
cmds.BoolOption("archive", "a", "Output a TAR archive."),
cmds.BoolOption("compress", "C", "Compress the output with GZIP compression."),
cmds.IntOption("compression-level", "l", "The level of compression (1-9)."),
},
PreRun: func(req cmds.Request) error {
_, err := getCompressOptions(req)

4
core/commands/id.go
View File

@ -50,10 +50,10 @@ ipfs id supports the format option for output with the following keys:
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("peerid", false, false, "peer.ID of node to look up").EnableStdin(),
cmds.StringArg("peerid", false, false, "Peer.ID of node to look up.").EnableStdin(),
},
Options: []cmds.Option{
cmds.StringOption("format", "f", "optional output format"),
cmds.StringOption("format", "f", "Optional output format."),
},
Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode()

4
core/commands/ipns.go
View File

@ -44,8 +44,8 @@ Resolve the value of another name:
cmds.StringArg("name", false, false, "The IPNS name to resolve. Defaults to your node's peerID.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("recursive", "r", "Resolve until the result is not an IPNS name"),
cmds.BoolOption("nocache", "n", "Do not used cached entries"),
cmds.BoolOption("recursive", "r", "Resolve until the result is not an IPNS name."),
cmds.BoolOption("nocache", "n", "Do not used cached entries."),
},
Run: func(req cmds.Request, res cmds.Response) {

2
core/commands/log.go
View File

@ -42,7 +42,7 @@ output of a running daemon.
// TODO use a different keyword for 'all' because all can theoretically
// clash with a subsystem name
cmds.StringArg("subsystem", true, false, fmt.Sprintf("the subsystem logging identifier. Use '%s' for all subsystems.", logAllKeyword)),
cmds.StringArg("level", true, false, "one of: debug, info, warning, error, fatal, panic"),
cmds.StringArg("level", true, false, "One of: debug, info, warning, error, fatal, panic."),
},
Run: func(req cmds.Request, res cmds.Response) {

4
core/commands/ls.go
View File

@ -41,10 +41,10 @@ it contains, with the following format:
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from").EnableStdin(),
cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("headers", "v", "Print table headers (Hash, Name, Size)"),
cmds.BoolOption("headers", "v", "Print table headers (Hash, Name, Size)."),
},
Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode()

4
core/commands/mount_unix.go
View File

@ -93,8 +93,8 @@ baz
`,
},
Options: []cmds.Option{
cmds.StringOption("ipfs-path", "f", "The path where IPFS should be mounted"),
cmds.StringOption("ipns-path", "n", "The path where IPNS should be mounted"),
cmds.StringOption("ipfs-path", "f", "The path where IPFS should be mounted."),
cmds.StringOption("ipns-path", "n", "The path where IPNS should be mounted."),
},
Run: func(req cmds.Request, res cmds.Response) {
cfg, err := req.InvocContext().GetConfig()

14
core/commands/object/object.go
View File

@ -87,7 +87,7 @@ output is the raw data of the object.
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format").EnableStdin(),
cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -117,7 +117,7 @@ multihash.
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format").EnableStdin(),
cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -176,7 +176,7 @@ This command outputs data in the following encodings:
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "Key of the object to retrieve (in base58-encoded multihash format)").EnableStdin(),
cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -242,7 +242,7 @@ var ObjectStatCmd = &cmds.Command{
},
Arguments: []cmds.Argument{
cmds.StringArg("key", true, false, "Key of the object to retrieve (in base58-encoded multihash format)").EnableStdin(),
cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -326,10 +326,10 @@ and then run
},
Arguments: []cmds.Argument{
cmds.FileArg("data", true, false, "Data to be stored as a DAG object").EnableStdin(),
cmds.FileArg("data", true, false, "Data to be stored as a DAG object.").EnableStdin(),
},
Options: []cmds.Option{
cmds.StringOption("inputenc", "Encoding type of input data, either \"protobuf\" or \"json\""),
cmds.StringOption("inputenc", "Encoding type of input data, either \"protobuf\" or \"json\"."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -391,7 +391,7 @@ Available templates:
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("template", false, false, "optional template to use"),
cmds.StringArg("template", false, false, "Optional template to use."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()

20
core/commands/object/patch.go
View File

@ -57,8 +57,8 @@ the limit will not be respected by the network.
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("root", true, false, "the hash of the node to modify"),
cmds.FileArg("data", true, false, "data to append").EnableStdin(),
cmds.StringArg("root", true, false, "The hash of the node to modify."),
cmds.FileArg("data", true, false, "Data to append.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()
@ -119,8 +119,8 @@ EXAMPLE:
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("root", true, false, "the hash of the node to modify"),
cmds.FileArg("data", true, false, "data fill with").EnableStdin(),
cmds.StringArg("root", true, false, "The hash of the node to modify."),
cmds.FileArg("data", true, false, "Data fill with.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()
@ -177,8 +177,8 @@ removes a link by the given name from root.
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("root", true, false, "the hash of the node to modify"),
cmds.StringArg("link", true, false, "name of the link to remove"),
cmds.StringArg("root", true, false, "The hash of the node to modify."),
cmds.StringArg("link", true, false, "Name of the link to remove."),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()
@ -246,12 +246,12 @@ a file containing 'bar', and returns the hash of the new object.
`,
},
Options: []cmds.Option{
cmds.BoolOption("p", "create", "create intermediary nodes"),
cmds.BoolOption("p", "create", "Create intermediary nodes."),
},
Arguments: []cmds.Argument{
cmds.StringArg("root", true, false, "the hash of the node to modify"),
cmds.StringArg("name", true, false, "name of link to create"),
cmds.StringArg("ref", true, false, "ipfs object to add link to"),
cmds.StringArg("root", true, false, "The hash of the node to modify."),
cmds.StringArg("name", true, false, "Name of link to create."),
cmds.StringArg("ref", true, false, "IPFS object to add link to."),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()

16
core/commands/pin.go
View File

@ -41,10 +41,10 @@ on disk.
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be pinned").EnableStdin(),
cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be pinned.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("recursive", "r", "Recursively pin the object linked to by the specified object(s)"),
cmds.BoolOption("recursive", "r", "Recursively pin the object linked to by the specified object(s)."),
},
Type: PinOutput{},
Run: func(req cmds.Request, res cmds.Response) {
@ -109,10 +109,10 @@ collected if needed. (By default, recursively. Use -r=false for direct pins)
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be unpinned").EnableStdin(),
cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be unpinned.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("recursive", "r", "Recursively unpin the object linked to by the specified object(s)"),
cmds.BoolOption("recursive", "r", "Recursively unpin the object linked to by the specified object(s)."),
},
Type: PinOutput{},
Run: func(req cmds.Request, res cmds.Response) {
@ -194,12 +194,12 @@ Example:
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", false, true, "Path to object(s) to be listed"),
cmds.StringArg("ipfs-path", false, true, "Path to object(s) to be listed."),
},
Options: []cmds.Option{
cmds.StringOption("type", "t", "The type of pinned keys to list. Can be \"direct\", \"indirect\", \"recursive\", or \"all\". Defaults to \"recursive\""),
cmds.BoolOption("count", "n", "Show refcount when listing indirect pins"),
cmds.BoolOption("quiet", "q", "Write just hashes of objects"),
cmds.StringOption("type", "t", "The type of pinned keys to list. Can be \"direct\", \"indirect\", \"recursive\", or \"all\". Defaults to \"recursive\"."),
cmds.BoolOption("count", "n", "Show refcount when listing indirect pins."),
cmds.BoolOption("quiet", "q", "Write just hashes of objects."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()

4
core/commands/ping.go
View File

@ -38,10 +38,10 @@ trip latency information.
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("peer ID", true, true, "ID of peer to be pinged").EnableStdin(),
cmds.StringArg("peer ID", true, true, "ID of peer to be pinged.").EnableStdin(),
},
Options: []cmds.Option{
cmds.IntOption("count", "n", "number of ping messages to send"),
cmds.IntOption("count", "n", "Number of ping messages to send."),
},
Marshalers: cmds.MarshalerMap{
cmds.Text: func(res cmds.Response) (io.Reader, error) {

8
core/commands/publish.go
View File

@ -47,12 +47,12 @@ Publish an <ipfs-path> to another public key (not implemented):
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, false, "IPFS path of the obejct to be published").EnableStdin(),
cmds.StringArg("ipfs-path", true, false, "IPFS path of the obejct to be published.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("resolve", "resolve given path before publishing (default=true)"),
cmds.StringOption("lifetime", "t", "time duration that the record will be valid for (default: 24hrs)"),
cmds.StringOption("ttl", "time duration this record should be cached for (caution: experimental)"),
cmds.BoolOption("resolve", "Resolve given path before publishing (default=true)."),
cmds.StringOption("lifetime", "t", "Time duration that the record will be valid for (default: 24hrs)."),
cmds.StringOption("ttl", "Time duration this record should be cached for (caution: experimental)."),
},
Run: func(req cmds.Request, res cmds.Response) {
log.Debug("Begin Publish")

10
core/commands/refs.go
View File

@ -47,13 +47,13 @@ Note: list all refs recursively with -r.
"local": RefsLocalCmd,
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, true, "Path to the object(s) to list refs from").EnableStdin(),
cmds.StringArg("ipfs-path", true, true, "Path to the object(s) to list refs from.").EnableStdin(),
},
Options: []cmds.Option{
cmds.StringOption("format", "Emit edges with given format. tokens: <src> <dst> <linkname>"),
cmds.BoolOption("edges", "e", "Emit edge format: `<from> -> <to>`"),
cmds.BoolOption("unique", "u", "Omit duplicate refs from output"),
cmds.BoolOption("recursive", "r", "Recursively list links of child nodes"),
cmds.StringOption("format", "Emit edges with given format. tokens: <src> <dst> <linkname>."),
cmds.BoolOption("edges", "e", "Emit edge format: `<from> -> <to>`."),
cmds.BoolOption("unique", "u", "Omit duplicate refs from output."),
cmds.BoolOption("recursive", "r", "Recursively list links of child nodes."),
},
Run: func(req cmds.Request, res cmds.Response) {
ctx := req.Context()

2
core/commands/repo.go
View File

@ -34,7 +34,7 @@ order to reclaim hard disk space.
},
Options: []cmds.Option{
cmds.BoolOption("quiet", "q", "Write minimal output"),
cmds.BoolOption("quiet", "q", "Write minimal output."),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()

2
core/commands/resolve.go
View File

@ -58,7 +58,7 @@ Resolve the value of an IPFS DAG path:
cmds.StringArg("name", true, false, "The name to resolve.").EnableStdin(),
},
Options: []cmds.Option{
cmds.BoolOption("recursive", "r", "Resolve until the result is an IPFS name"),
cmds.BoolOption("recursive", "r", "Resolve until the result is an IPFS name."),
},
Run: func(req cmds.Request, res cmds.Response) {

10
core/commands/root.go
View File

@ -79,11 +79,11 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
`,
},
Options: []cmds.Option{
cmds.StringOption("config", "c", "Path to the configuration file to use"),
cmds.BoolOption("debug", "D", "Operate in debug mode"),
cmds.BoolOption("help", "Show the full command help text"),
cmds.BoolOption("h", "Show a short version of the command help text"),
cmds.BoolOption("local", "L", "Run the command locally, instead of using the daemon"),
cmds.StringOption("config", "c", "Path to the configuration file to use."),
cmds.BoolOption("debug", "D", "Operate in debug mode."),
cmds.BoolOption("help", "Show the full command help text."),
cmds.BoolOption("h", "Show a short version of the command help text."),
cmds.BoolOption("local", "L", "Run the command locally, instead of using the daemon."),
cmds.StringOption(ApiOption, "Use a specific API instance (defaults to /ip4/127.0.0.1/tcp/5001)"),
},
}

8
core/commands/stat.go
View File

@ -33,10 +33,10 @@ var statBwCmd = &cmds.Command{
ShortDescription: ``,
},
Options: []cmds.Option{
cmds.StringOption("peer", "p", "specify a peer to print bandwidth for"),
cmds.StringOption("proto", "t", "specify a protocol to print bandwidth for"),
cmds.BoolOption("poll", "print bandwidth at an interval"),
cmds.StringOption("interval", "i", "time interval to wait between updating output"),
cmds.StringOption("peer", "p", "Specify a peer to print bandwidth for."),
cmds.StringOption("proto", "t", "Specify a protocol to print bandwidth for."),
cmds.BoolOption("poll", "Print bandwidth at an interval."),
cmds.StringOption("interval", "i", "Time interval to wait between updating output."),
},
Run: func(req cmds.Request, res cmds.Response) {

10
core/commands/swarm.go
View File

@ -159,7 +159,7 @@ ipfs swarm addrs local lists all local addresses the node is listening on.
`,
},
Options: []cmds.Option{
cmds.BoolOption("id", "Show peer ID in addresses"),
cmds.BoolOption("id", "Show peer ID in addresses."),
},
Run: func(req cmds.Request, res cmds.Response) {
@ -207,7 +207,7 @@ ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("address", true, true, "address of peer to connect to").EnableStdin(),
cmds.StringArg("address", true, true, "Address of peer to connect to.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
ctx := req.Context()
@ -262,7 +262,7 @@ ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQA
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("address", true, true, "address of peer to connect to").EnableStdin(),
cmds.StringArg("address", true, true, "Address of peer to connect to.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -429,7 +429,7 @@ add your filters to the ipfs config file.
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("address", true, true, "multiaddr to filter").EnableStdin(),
cmds.StringArg("address", true, true, "Multiaddr to filter.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()
@ -471,7 +471,7 @@ remove your filters from the ipfs config file.
`,
},
Arguments: []cmds.Argument{
cmds.StringArg("address", true, true, "multiaddr filter to remove").EnableStdin(),
cmds.StringArg("address", true, true, "Multiaddr filter to remove.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
n, err := req.InvocContext().GetNode()

4
core/commands/tar.go
View File

@ -31,7 +31,7 @@ var tarAddCmd = &cmds.Command{
},
Arguments: []cmds.Argument{
cmds.FileArg("file", true, false, "tar file to add").EnableStdin(),
cmds.FileArg("file", true, false, "Tar file to add.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()
@ -82,7 +82,7 @@ var tarCatCmd = &cmds.Command{
},
Arguments: []cmds.Argument{
cmds.StringArg("path", true, false, "ipfs path of archive to export").EnableStdin(),
cmds.StringArg("path", true, false, "Ipfs path of archive to export.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
nd, err := req.InvocContext().GetNode()

2
core/commands/tour.go
View File

@ -25,7 +25,7 @@ IPFS very quickly. To start, run:
},
Arguments: []cmds.Argument{
cmds.StringArg("id", false, false, "The id of the topic you would like to tour"),
cmds.StringArg("id", false, false, "The id of the topic you would like to tour."),
},
Subcommands: map[string]*cmds.Command{
"list": cmdIpfsTourList,

2
core/commands/unixfs/ls.go
View File

@ -46,7 +46,7 @@ size is the IPFS link size.
},
Arguments: []cmds.Argument{
cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from").EnableStdin(),
cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from.").EnableStdin(),
},
Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode()

6
core/commands/version.go
View File

@ -23,9 +23,9 @@ var VersionCmd = &cmds.Command{
},
Options: []cmds.Option{
cmds.BoolOption("number", "n", "Only show the version number"),
cmds.BoolOption("commit", "Show the commit hash"),
cmds.BoolOption("repo", "Show repo version"),
cmds.BoolOption("number", "n", "Only show the version number."),
cmds.BoolOption("commit", "Show the commit hash."),
cmds.BoolOption("repo", "Show repo version."),
},
Run: func(req cmds.Request, res cmds.Response) {
res.SetOutput(&VersionOutput{