@cryptotaxi247 / kubo / commits / 0ff1cf33a

docs: cosmetic fixes of help text

Unfortunately, API docs are genereted from go-ipfs sources via https://github.com/ipfs/http-api-docs so it all gets lost when API docs for new version are re-generated. This re-applies manual fixes from: https://docs.ipfs.io/reference/http/api/ so the next time http-api-docs are re-generated, those changes stay.

Marcin Rataj committed Mar 24, 2021 at 17:41 UTC 0ff1cf33aa03014265335b0c72b104bb90b8279a
19 files changed +54 -55
README.md
+7 -7
@@ -288,10 +288,10 @@ Basic proof of 'ipfs working' locally:
288
289 SUBCOMMANDS
290 BASIC COMMANDS
291 - init Initialize ipfs local configuration
292 - add <path> Add a file to ipfs
293 - cat <ref> Show ipfs object data
294 - get <ref> Download ipfs objects
291 + init Initialize local IPFS configuration
292 + add <path> Add a file to IPFS
293 + cat <ref> Show IPFS object data
294 + get <ref> Download IPFS objects
295 ls <ref> List links from an object
296 refs <ref> List hashes of links from an object
297
@@ -302,7 +302,7 @@ SUBCOMMANDS
302
303 ADVANCED COMMANDS
304 daemon Start a long-running daemon process
305 - mount Mount an ipfs read-only mount point
305 + mount Mount an IPFS read-only mount point
306 resolve Resolve any type of name
307 name Publish or resolve IPNS names
308 dns Resolve DNS links
@@ -310,7 +310,7 @@ SUBCOMMANDS
310 repo Manipulate an IPFS repository
311
312 NETWORK COMMANDS
313 - id Show info about ipfs peers
313 + id Show info about IPFS peers
314 bootstrap Add or remove bootstrap peers
315 swarm Manage connections to the p2p network
316 dht Query the DHT for values or peers
@@ -319,7 +319,7 @@ SUBCOMMANDS
319
320 TOOL COMMANDS
321 config Manage configuration
322 - version Show ipfs version information
322 + version Show IPFS version information
323 update Download and apply go-ipfs updates
324 commands List all available commands
325
core/commands/add.go
+5 -5
@@ -51,13 +51,13 @@ const adderOutChanSize = 8
51
52 var AddCmd = &cmds.Command{
53 Helptext: cmds.HelpText{
54 - Tagline: "Add a file or directory to ipfs.",
54 + Tagline: "Add a file or directory to IPFS.",
55 ShortDescription: `
56 -Adds contents of <path> to ipfs. Use -r to add directories (recursively).
56 +Adds contents of <path> to IPFS. Use -r to add directories (recursively).
57 `,
58 LongDescription: `
59 -Adds contents of <path> to ipfs. Use -r to add directories.
60 -Note that directories are added recursively, to form the ipfs
59 +Adds contents of <path> to IPFS. Use -r to add directories.
60 +Note that directories are added recursively, to form the IPFS
61 MerkleDAG.
62
63 If the daemon is not running, it will just add locally.
@@ -115,7 +115,7 @@ only-hash, and progress/status related flags) will change the final hash.
115 },
116
117 Arguments: []cmds.Argument{
118 - cmds.FileArg("path", true, true, "The path to a file to be added to ipfs.").EnableRecursive().EnableStdin(),
118 + cmds.FileArg("path", true, true, "The path to a file to be added to IPFS.").EnableRecursive().EnableStdin(),
119 },
120 Options: []cmds.Option{
121 cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)
core/commands/config.go
+2 -2
@@ -38,10 +38,10 @@ const (
38
39 var ConfigCmd = &cmds.Command{
40 Helptext: cmds.HelpText{
41 - Tagline: "Get and set ipfs config values.",
41 + Tagline: "Get and set IPFS config values.",
42 ShortDescription: `
43 'ipfs config' controls configuration variables. It works like 'git config'.
44 -The configuration values are stored in a config file inside your ipfs
44 +The configuration values are stored in a config file inside your IPFS_PATH
45 repository.`,
46 LongDescription: `
47 'ipfs config' controls configuration variables. It works
core/commands/dag/dag.go
+10 -10
@@ -24,9 +24,9 @@ const (
24 // DagCmd provides a subset of commands for interacting with ipld dag objects
25 var DagCmd = &cmds.Command{
26 Helptext: cmds.HelpText{
27 - Tagline: "Interact with ipld dag objects.",
27 + Tagline: "Interact with IPLD DAG objects.",
28 ShortDescription: `
29 -'ipfs dag' is used for creating and manipulating dag objects/hierarchies.
29 +'ipfs dag' is used for creating and manipulating DAG objects/hierarchies.
30
31 This subcommand is currently an experimental feature, but it is intended
32 to deprecate and replace the existing 'ipfs object' command moving forward.
@@ -67,7 +67,7 @@ type RootMeta struct {
67 // DagPutCmd is a command for adding a dag node
68 var DagPutCmd = &cmds.Command{
69 Helptext: cmds.HelpText{
70 - Tagline: "Add a dag node to ipfs.",
70 + Tagline: "Add a DAG node to IPFS.",
71 ShortDescription: `
72 'ipfs dag put' accepts input from a file or stdin and parses it
73 into an object of the specified format.
@@ -99,9 +99,9 @@ into an object of the specified format.
99 // DagGetCmd is a command for getting a dag node from IPFS
100 var DagGetCmd = &cmds.Command{
101 Helptext: cmds.HelpText{
102 - Tagline: "Get a dag node from ipfs.",
102 + Tagline: "Get a DAG node from IPFS.",
103 ShortDescription: `
104 -'ipfs dag get' fetches a dag node from ipfs and prints it out in the specified
104 +'ipfs dag get' fetches a DAG node from IPFS and prints it out in the specified
105 format.
106 `,
107 },
@@ -114,9 +114,9 @@ format.
114 // DagResolveCmd returns address of highest block within a path and a path remainder
115 var DagResolveCmd = &cmds.Command{
116 Helptext: cmds.HelpText{
117 - Tagline: "Resolve ipld block",
117 + Tagline: "Resolve IPLD block.",
118 ShortDescription: `
119 -'ipfs dag resolve' fetches a dag node from ipfs, prints its address and remaining path.
119 +'ipfs dag resolve' fetches a DAG node from IPFS, prints its address and remaining path.
120 `,
121 },
122 Arguments: []cmds.Argument{
@@ -230,7 +230,7 @@ var DagExportCmd = &cmds.Command{
230 Helptext: cmds.HelpText{
231 Tagline: "Streams the selected DAG as a .car stream on stdout.",
232 ShortDescription: `
233 -'ipfs dag export' fetches a dag and streams it out as a well-formed .car file.
233 +'ipfs dag export' fetches a DAG and streams it out as a well-formed .car file.
234 Note that at present only single root selections / .car files are supported.
235 The output of blocks happens in strict DAG-traversal, first-seen, order.
236 `,
@@ -260,9 +260,9 @@ func (s *DagStat) String() string {
260 // DagStatCmd is a command for getting size information about an ipfs-stored dag
261 var DagStatCmd = &cmds.Command{
262 Helptext: cmds.HelpText{
263 - Tagline: "Gets stats for a DAG",
263 + Tagline: "Gets stats for a DAG.",
264 ShortDescription: `
265 -'ipfs dag stat' fetches a dag and returns various statistics about the DAG.
265 +'ipfs dag stat' fetches a DAG and returns various statistics about it.
266 Statistics include size and number of blocks.
267
268 Note: This command skips duplicate blocks in reporting both size and the number of blocks
core/commands/files.go
+4 -4
@@ -10,10 +10,10 @@ import (
10 "sort"
11 "strings"
12
13 + humanize "github.com/dustin/go-humanize"
14 "github.com/ipfs/go-ipfs/core"
15 "github.com/ipfs/go-ipfs/core/commands/cmdenv"
16
16 - "github.com/dustin/go-humanize"
17 bservice "github.com/ipfs/go-blockservice"
18 cid "github.com/ipfs/go-cid"
19 cidenc "github.com/ipfs/go-cidutil/cidenc"
@@ -22,7 +22,7 @@ import (
22 ipld "github.com/ipfs/go-ipld-format"
23 logging "github.com/ipfs/go-log"
24 dag "github.com/ipfs/go-merkledag"
25 - "github.com/ipfs/go-mfs"
25 + mfs "github.com/ipfs/go-mfs"
26 ft "github.com/ipfs/go-unixfs"
27 iface "github.com/ipfs/interface-go-ipfs-core"
28 path "github.com/ipfs/interface-go-ipfs-core/path"
@@ -943,9 +943,9 @@ are run with the '--flush=false'.
943
944 var filesChcidCmd = &cmds.Command{
945 Helptext: cmds.HelpText{
946 - Tagline: "Change the cid version or hash function of the root node of a given path.",
946 + Tagline: "Change the CID version or hash function of the root node of a given path.",
947 ShortDescription: `
948 -Change the cid version or hash function of the root node of a given path.
948 +Change the CID version or hash function of the root node of a given path.
949 `,
950 },
951 Arguments: []cmds.Argument{
core/commands/id.go
+1 -1
@@ -48,7 +48,7 @@ const (
48
49 var IDCmd = &cmds.Command{
50 Helptext: cmds.HelpText{
51 - Tagline: "Show ipfs node id info.",
51 + Tagline: "Show IPFS node id info.",
52 ShortDescription: `
53 Prints out information about the specified peer.
54 If no peer is specified, prints out information for local peers.
core/commands/keystore.go
+4 -4
@@ -300,7 +300,7 @@ var keyImportCmd = &cmds.Command{
300
301 var keyListCmd = &cmds.Command{
302 Helptext: cmds.HelpText{
303 - Tagline: "List all local keypairs",
303 + Tagline: "List all local keypairs.",
304 },
305 Options: []cmds.Option{
306 cmds.BoolOption("l", "Show extra information about keys."),
@@ -345,7 +345,7 @@ const (
345
346 var keyRenameCmd = &cmds.Command{
347 Helptext: cmds.HelpText{
348 - Tagline: "Rename a keypair",
348 + Tagline: "Rename a keypair.",
349 },
350 Arguments: []cmds.Argument{
351 cmds.StringArg("name", true, false, "name of key to rename"),
@@ -396,7 +396,7 @@ var keyRenameCmd = &cmds.Command{
396
397 var keyRmCmd = &cmds.Command{
398 Helptext: cmds.HelpText{
399 - Tagline: "Remove a keypair",
399 + Tagline: "Remove a keypair.",
400 },
401 Arguments: []cmds.Argument{
402 cmds.StringArg("name", true, true, "names of keys to remove").EnableStdin(),
@@ -440,7 +440,7 @@ var keyRmCmd = &cmds.Command{
440
441 var keyRotateCmd = &cmds.Command{
442 Helptext: cmds.HelpText{
443 - Tagline: "Rotates the ipfs identity.",
443 + Tagline: "Rotates the IPFS identity.",
444 ShortDescription: `
445 Generates a new ipfs identity and saves it to the ipfs config file.
446 Your existing identity key will be backed up in the Keystore.
core/commands/name/ipnsps.go
+3 -3
@@ -43,7 +43,7 @@ Note: this command is experimental and subject to change as the system is refine
43
44 var ipnspsStateCmd = &cmds.Command{
45 Helptext: cmds.HelpText{
46 - Tagline: "Query the state of IPNS pubsub",
46 + Tagline: "Query the state of IPNS pubsub.",
47 },
48 Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
49 n, err := cmdenv.GetNode(env)
@@ -71,7 +71,7 @@ var ipnspsStateCmd = &cmds.Command{
71
72 var ipnspsSubsCmd = &cmds.Command{
73 Helptext: cmds.HelpText{
74 - Tagline: "Show current name subscriptions",
74 + Tagline: "Show current name subscriptions.",
75 },
76 Options: []cmds.Option{
77 ke.OptionIPNSBase,
@@ -115,7 +115,7 @@ var ipnspsSubsCmd = &cmds.Command{
115
116 var ipnspsCancelCmd = &cmds.Command{
117 Helptext: cmds.HelpText{
118 - Tagline: "Cancel a name subscription",
118 + Tagline: "Cancel a name subscription.",
119 },
120 Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
121 n, err := cmdenv.GetNode(env)
core/commands/object/diff.go
+1 -1
@@ -21,7 +21,7 @@ type Changes struct {
21
22 var ObjectDiffCmd = &cmds.Command{
23 Helptext: cmds.HelpText{
24 - Tagline: "Display the diff between two ipfs objects.",
24 + Tagline: "Display the diff between two IPFS objects.",
25 ShortDescription: `
26 'ipfs object diff' is a command used to show the differences between
27 two IPFS objects.`,
core/commands/object/object.go
+2 -2
@@ -8,11 +8,11 @@ import (
8 "io/ioutil"
9 "text/tabwriter"
10
11 + cmds "github.com/ipfs/go-ipfs-cmds"
12 "github.com/ipfs/go-ipfs/core/commands/cmdenv"
13
14 humanize "github.com/dustin/go-humanize"
15 "github.com/ipfs/go-cid"
15 - "github.com/ipfs/go-ipfs-cmds"
16 ipld "github.com/ipfs/go-ipld-format"
17 dag "github.com/ipfs/go-merkledag"
18 "github.com/ipfs/interface-go-ipfs-core/options"
@@ -466,7 +466,7 @@ And then run:
466 // ObjectNewCmd object new command
467 var ObjectNewCmd = &cmds.Command{
468 Helptext: cmds.HelpText{
469 - Tagline: "Create a new object from an ipfs template.",
469 + Tagline: "Create a new object from an IPFS template.",
470 ShortDescription: `
471 'ipfs object new' is a plumbing command for creating new DAG nodes.
472 `,
core/commands/object/patch.go
+2 -2
@@ -4,9 +4,9 @@ import (
4 "fmt"
5 "io"
6
7 + cmds "github.com/ipfs/go-ipfs-cmds"
8 "github.com/ipfs/go-ipfs/core/commands/cmdenv"
9
9 - "github.com/ipfs/go-ipfs-cmds"
10 "github.com/ipfs/interface-go-ipfs-core/options"
11 "github.com/ipfs/interface-go-ipfs-core/path"
12 )
@@ -31,7 +31,7 @@ result. This is the Merkle-DAG version of modifying an object.
31
32 var patchAppendDataCmd = &cmds.Command{
33 Helptext: cmds.HelpText{
34 - Tagline: "Append data to the data segment of a dag node.",
34 + Tagline: "Append data to the data segment of a DAG node.",
35 ShortDescription: `
36 Append data to what already exists in the data segment in the given object.
37
core/commands/p2p.go
+2 -2
@@ -79,7 +79,7 @@ are refined`,
79
80 var p2pForwardCmd = &cmds.Command{
81 Helptext: cmds.HelpText{
82 - Tagline: "Forward connections to libp2p service",
82 + Tagline: "Forward connections to libp2p service.",
83 ShortDescription: `
84 Forward connections made to <listen-address> to <target-address>.
85
@@ -180,7 +180,7 @@ func parseIpfsAddr(addr string) (*peer.AddrInfo, error) {
180
181 var p2pListenCmd = &cmds.Command{
182 Helptext: cmds.HelpText{
183 - Tagline: "Create libp2p service",
183 + Tagline: "Create libp2p service.",
184 ShortDescription: `
185 Create libp2p service and forward connections made to <target-address>.
186
core/commands/pin/pin.go
+1 -1
@@ -523,7 +523,7 @@ const (
523
524 var updatePinCmd = &cmds.Command{
525 Helptext: cmds.HelpText{
526 - Tagline: "Update a recursive pin",
526 + Tagline: "Update a recursive pin.",
527 ShortDescription: `
528 Efficiently pins a new object based on differences from an existing one and,
529 by default, removes the old pin.
core/commands/root.go
+1 -1
@@ -68,7 +68,7 @@ NETWORK COMMANDS
68
69 TOOL COMMANDS
70 config Manage configuration
71 - version Show ipfs version information
71 + version Show IPFS version information
72 update Download and apply go-ipfs updates
73 commands List all available commands
74 cid Convert and discover properties of CIDs
core/commands/shutdown.go
+2 -3
@@ -1,14 +1,13 @@
1 package commands
2
3 import (
4 + cmds "github.com/ipfs/go-ipfs-cmds"
5 cmdenv "github.com/ipfs/go-ipfs/core/commands/cmdenv"
5 -
6 - "github.com/ipfs/go-ipfs-cmds"
6 )
7
8 var daemonShutdownCmd = &cmds.Command{
9 Helptext: cmds.HelpText{
11 - Tagline: "Shut down the ipfs daemon",
10 + Tagline: "Shut down the IPFS daemon.",
11 },
12 Run: func(req *cmds.Request, re cmds.ResponseEmitter, env cmds.Environment) error {
13 nd, err := cmdenv.GetNode(env)
core/commands/stat.go
+1 -1
@@ -42,7 +42,7 @@ const (
42
43 var statBwCmd = &cmds.Command{
44 Helptext: cmds.HelpText{
45 - Tagline: "Print ipfs bandwidth information.",
45 + Tagline: "Print IPFS bandwidth information.",
46 ShortDescription: `'ipfs stats bw' prints bandwidth information for the ipfs daemon.
47 It displays: TotalIn, TotalOut, RateIn, RateOut.
48 `,
core/commands/stat_dht.go
+1 -1
@@ -35,7 +35,7 @@ type dhtBucket struct {
35
36 var statDhtCmd = &cmds.Command{
37 Helptext: cmds.HelpText{
38 - Tagline: "Returns statistics about the node's DHT(s)",
38 + Tagline: "Returns statistics about the node's DHT(s).",
39 ShortDescription: `
40 Returns statistics about the DHT(s) the node is participating in.
41
core/commands/tar.go
+2 -2
@@ -4,10 +4,10 @@ import (
4 "fmt"
5 "io"
6
7 + cmds "github.com/ipfs/go-ipfs-cmds"
8 "github.com/ipfs/go-ipfs/core/commands/cmdenv"
9 tar "github.com/ipfs/go-ipfs/tar"
10
10 - "github.com/ipfs/go-ipfs-cmds"
11 dag "github.com/ipfs/go-merkledag"
12 path "github.com/ipfs/interface-go-ipfs-core/path"
13 )
@@ -25,7 +25,7 @@ var TarCmd = &cmds.Command{
25
26 var tarAddCmd = &cmds.Command{
27 Helptext: cmds.HelpText{
28 - Tagline: "Import a tar file into ipfs.",
28 + Tagline: "Import a tar file into IPFS.",
29 ShortDescription: `
30 'ipfs tar add' will parse a tar file and create a merkledag structure to
31 represent it.
core/commands/version.go
+3 -3
@@ -30,8 +30,8 @@ const (
30
31 var VersionCmd = &cmds.Command{
32 Helptext: cmds.HelpText{
33 - Tagline: "Show ipfs version information.",
34 - ShortDescription: "Returns the current version of ipfs and exits.",
33 + Tagline: "Show IPFS version information.",
34 + ShortDescription: "Returns the current version of IPFS and exits.",
35 },
36 Subcommands: map[string]*cmds.Command{
37 "deps": depsVersionCommand,
@@ -105,7 +105,7 @@ const pkgVersionFmt = "%s@%s"
105
106 var depsVersionCommand = &cmds.Command{
107 Helptext: cmds.HelpText{
108 - Tagline: "Shows information about dependencies used for build",
108 + Tagline: "Shows information about dependencies used for build.",
109 ShortDescription: `
110 Print out all dependencies and their versions.`,
111 },