@cryptotaxi247 / kubo / commits / 9aaa743a5

docs: decapitalize IPFS where possible

Tried to check all instances of IPFS and make sure they werent referring to the CLI tool. See #2910. License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>

Richard Littauer committed Jun 27, 2016 at 10:32 UTC 9aaa743a51d1029c9f418d08bb606cd5db35f5d3
19 files changed +43 -43
cmd/ipfs/daemon.go
+8 -8
@@ -54,9 +54,9 @@ const (
54
55 var daemonCmd = &cmds.Command{
56 Helptext: cmds.HelpText{
57 - Tagline: "Run a network-connected IPFS node.",
57 + Tagline: "Run a network-connected ipfs node.",
58 ShortDescription: `
59 -'ipfs daemon' runs a persistent IPFS daemon that can serve commands
59 +'ipfs daemon' runs a persistent ipfs daemon that can serve commands
60 over the network. Most applications that use IPFS will do so by
61 communicating with a daemon over the HTTP API. While the daemon is
62 running, calls to 'ipfs' commands will be sent over the network to
@@ -87,7 +87,7 @@ make sure to protect the port as you would other services or database
87
88 HTTP Headers
89
90 -IPFS supports passing arbitrary headers to the API and Gateway. You can
90 +ipfs supports passing arbitrary headers to the API and Gateway. You can
91 do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
92 keys:
93
@@ -134,7 +134,7 @@ This will later be transitioned into a config option once it gets out of the
134
135 DEPRECATION NOTICE
136
137 -Previously, IPFS used an environment variable as seen below:
137 +Previously, ipfs used an environment variable as seen below:
138
139 export API_ORIGIN="http://localhost:8888/"
140
@@ -145,11 +145,11 @@ Headers.
145 },
146
147 Options: []cmds.Option{
148 - cmds.BoolOption(initOptionKwd, "Initialize IPFS with default settings if not already initialized").Default(false),
148 + cmds.BoolOption(initOptionKwd, "Initialize ipfs with default settings if not already initialized").Default(false),
149 cmds.StringOption(routingOptionKwd, "Overrides the routing option").Default("dht"),
150 - cmds.BoolOption(mountKwd, "Mounts IPFS to the filesystem").Default(false),
150 + cmds.BoolOption(mountKwd, "Mounts ipfs to the filesystem").Default(false),
151 cmds.BoolOption(writableKwd, "Enable writing objects (with POST, PUT and DELETE)").Default(false),
152 - cmds.StringOption(ipfsMountKwd, "Path to the mountpoint for IPFS (if using --mount). Defaults to config setting."),
152 + cmds.StringOption(ipfsMountKwd, "Path to the mountpoint for ipfs (if using --mount). Defaults to config setting."),
153 cmds.StringOption(ipnsMountKwd, "Path to the mountpoint for IPNS (if using --mount). Defaults to config setting."),
154 cmds.BoolOption(unrestrictedApiAccessKwd, "Allow API access to unlisted hashes").Default(false),
155 cmds.BoolOption(unencryptTransportKwd, "Disable transport encryption (for debugging protocols)").Default(false),
@@ -226,7 +226,7 @@ func daemonFunc(req cmds.Request, res cmds.Response) {
226
227 if initialize {
228
229 - // now, FileExists is our best method of detecting whether IPFS is
229 + // now, FileExists is our best method of detecting whether ipfs is
230 // configured. Consider moving this into a config helper method
231 // `IsInitialized` where the quality of the signal can be improved over
232 // time, and many call-sites can benefit.
cmd/ipfs/init.go
+2 -2
@@ -23,9 +23,9 @@ const (
23
24 var initCmd = &cmds.Command{
25 Helptext: cmds.HelpText{
26 - Tagline: "Initializes IPFS config file.",
26 + Tagline: "Initializes ipfs config file.",
27 ShortDescription: `
28 -Initializes IPFS configuration files and generates a new keypair.
28 +Initializes ipfs configuration files and generates a new keypair.
29
30 ipfs uses a repository in the local file system. By default, the repo is
31 located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
core/commands/add.go
+1 -1
@@ -66,7 +66,7 @@ You can now refer to the added file in a gateway, like so:
66 },
67
68 Arguments: []cmds.Argument{
69 - cmds.FileArg("path", true, true, "The path to a file to be added to IPFS.").EnableRecursive().EnableStdin(),
69 + cmds.FileArg("path", true, true, "The path to a file to be added to ipfs.").EnableRecursive().EnableStdin(),
70 },
71 Options: []cmds.Option{
72 cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)
core/commands/block.go
+6 -6
@@ -28,7 +28,7 @@ var BlockCmd = &cmds.Command{
28 Helptext: cmds.HelpText{
29 Tagline: "Interact with raw IPFS blocks.",
30 ShortDescription: `
31 -'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
31 +'ipfs block' is a plumbing command used to manipulate raw IPFS blocks.
32 Reads from stdin or writes to stdout, and <key> is a base58 encoded
33 multihash.
34 `,
@@ -44,10 +44,10 @@ multihash.
44
45 var blockStatCmd = &cmds.Command{
46 Helptext: cmds.HelpText{
47 - Tagline: "Print information of a raw IPFS block.",
47 + Tagline: "Print information of a raw ipfs block.",
48 ShortDescription: `
49 'ipfs block stat' is a plumbing command for retrieving information
50 -on raw ipfs blocks. It outputs the following to stdout:
50 +on raw IPFS blocks. It outputs the following to stdout:
51
52 Key - the base58 encoded multihash
53 Size - the size of the block in bytes
@@ -81,9 +81,9 @@ on raw ipfs blocks. It outputs the following to stdout:
81
82 var blockGetCmd = &cmds.Command{
83 Helptext: cmds.HelpText{
84 - Tagline: "Get a raw IPFS block.",
84 + Tagline: "Get a raw ipfs block.",
85 ShortDescription: `
86 -'ipfs block get' is a plumbing command for retrieving raw ipfs blocks.
86 +'ipfs block get' is a plumbing command for retrieving raw IPFS blocks.
87 It outputs to stdout, and <key> is a base58 encoded multihash.
88 `,
89 },
@@ -106,7 +106,7 @@ var blockPutCmd = &cmds.Command{
106 Helptext: cmds.HelpText{
107 Tagline: "Store input as an IPFS block.",
108 ShortDescription: `
109 -'ipfs block put' is a plumbing command for storing raw ipfs blocks.
109 +'ipfs block put' is a plumbing command for storing raw IPFS blocks.
110 It reads from stdin, and <key> is a base58 encoded multihash.
111 `,
112 },
core/commands/config.go
+3 -3
@@ -26,15 +26,15 @@ type ConfigField struct {
26
27 var ConfigCmd = &cmds.Command{
28 Helptext: cmds.HelpText{
29 - Tagline: "Get and set IPFS config values.",
29 + Tagline: "Get and set ipfs config values.",
30 ShortDescription: `
31 'ipfs config' controls configuration variables. It works like 'git config'.
32 -The configuration values are stored in a config file inside your IPFS
32 +The configuration values are stored in a config file inside your ipfs
33 repository.`,
34 LongDescription: `
35 'ipfs config' controls configuration variables. It works
36 much like 'git config'. The configuration values are stored in a config
37 -file inside your IPFS repository.
37 +file inside your ipfs repository.
38
39 Examples:
40
core/commands/id.go
+1 -1
@@ -40,7 +40,7 @@ type IdOutput struct {
40
41 var IDCmd = &cmds.Command{
42 Helptext: cmds.HelpText{
43 - Tagline: "Show IPFS Node ID info.",
43 + Tagline: "Show ipfs node id info.",
44 ShortDescription: `
45 Prints out information about the specified peer.
46 If no peer is specified, prints out information for local peers.
core/commands/mount_nofuse.go
+1 -1
@@ -9,7 +9,7 @@ import (
9
10 var MountCmd = &cmds.Command{
11 Helptext: cmds.HelpText{
12 - Tagline: "Mount IPFS to the filesystem (disabled).",
12 + Tagline: "Mounts ipfs to the filesystem (disabled).",
13 ShortDescription: `
14 This version of ipfs is compiled without fuse support, which is required
15 for mounting. If you'd like to be able to mount, please use a version of
core/commands/mount_unix.go
+4 -4
@@ -15,10 +15,10 @@ import (
15
16 var MountCmd = &cmds.Command{
17 Helptext: cmds.HelpText{
18 - Tagline: "Mount IPFS to the filesystem (read-only).",
18 + Tagline: "Mounts ipfs to the filesystem (read-only).",
19 ShortDescription: `
20 Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
21 -All ipfs objects will be accessible under that directory. Note that the
21 +All IPFS objects will be accessible under that directory. Note that the
22 root will not be listable, as it is virtual. Access known paths directly.
23
24 You may have to create /ipfs and /ipns before using 'ipfs mount':
@@ -31,7 +31,7 @@ You may have to create /ipfs and /ipns before using 'ipfs mount':
31 LongDescription: `
32 Mount ipfs at a read-only mountpoint on the OS. The default, /ipfs and /ipns,
33 are set in the configutation file, but can be overriden by the options.
34 -All ipfs objects will be accessible under this directory. Note that the
34 +All IPFS objects will be accessible under this directory. Note that the
35 root will not be listable, as it is virtual. Access known paths directly.
36
37 You may have to create /ipfs and /ipns before using 'ipfs mount':
@@ -71,7 +71,7 @@ baz
71 `,
72 },
73 Options: []cmds.Option{
74 - cmds.StringOption("ipfs-path", "f", "The path where IPFS should be mounted."),
74 + cmds.StringOption("ipfs-path", "f", "The path where ipfs should be mounted."),
75 cmds.StringOption("ipns-path", "n", "The path where IPNS should be mounted."),
76 },
77 Run: func(req cmds.Request, res cmds.Response) {
core/commands/object/diff.go
+2 -2
@@ -21,10 +21,10 @@ var ObjectDiffCmd = &cmds.Command{
21 Tagline: "Display the diff between two ipfs objects.",
22 ShortDescription: `
23 'ipfs object diff' is a command used to show the differences between
24 -two ipfs objects.`,
24 +two IPFS objects.`,
25 LongDescription: `
26 'ipfs object diff' is a command used to show the differences between
27 -two ipfs objects.
27 +two IPFS objects.
28
29 Example:
30
core/commands/object/object.go
+1 -1
@@ -44,7 +44,7 @@ type Object struct {
44
45 var ObjectCmd = &cmds.Command{
46 Helptext: cmds.HelpText{
47 - Tagline: "Interact with ipfs objects.",
47 + Tagline: "Interact with IPFS objects.",
48 ShortDescription: `
49 'ipfs object' is a plumbing command used to manipulate DAG objects
50 directly.`,
core/commands/object/patch.go
+2 -2
@@ -115,9 +115,9 @@ the limit will not be respected by the network.
115
116 var patchSetDataCmd = &cmds.Command{
117 Helptext: cmds.HelpText{
118 - Tagline: "Set the data field of an ipfs object.",
118 + Tagline: "Set the data field of an IPFS object.",
119 ShortDescription: `
120 -Set the data of an ipfs object from stdin or with the contents of a file.
120 +Set the data of an IPFS object from stdin or with the contents of a file.
121
122 Example:
123
core/commands/publish.go
+1 -1
@@ -47,7 +47,7 @@ Publish an <ipfs-path> to another public key (not implemented):
47 },
48
49 Arguments: []cmds.Argument{
50 - cmds.StringArg("ipfs-path", true, false, "IPFS path of the object to be published.").EnableStdin(),
50 + cmds.StringArg("ipfs-path", true, false, "ipfs path of the object to be published.").EnableStdin(),
51 },
52 Options: []cmds.Option{
53 cmds.BoolOption("resolve", "Resolve given path before publishing.").Default(true),
core/commands/repo.go
+1 -1
@@ -24,7 +24,7 @@ type RepoVersion struct {
24
25 var RepoCmd = &cmds.Command{
26 Helptext: cmds.HelpText{
27 - Tagline: "Interact with the IPFS repo.",
27 + Tagline: "Manipulate the ipfs repo.",
28 ShortDescription: `
29 'ipfs repo' is a plumbing command used to manipulate the repo.
30 `,
core/commands/root.go
+2 -2
@@ -25,8 +25,8 @@ var Root = &cmds.Command{
25 BASIC COMMANDS
26 init Initialize ipfs local configuration
27 add <path> Add a file to ipfs
28 - cat <ref> Show ipfs object data
29 - get <ref> Download ipfs objects
28 + cat <ref> Show IPFS object data
29 + get <ref> Download IPFS objects
30 ls <ref> List links from an object
31 refs <ref> List hashes of links from an object
32
core/commands/tar.go
+2 -2
@@ -14,7 +14,7 @@ import (
14
15 var TarCmd = &cmds.Command{
16 Helptext: cmds.HelpText{
17 - Tagline: "Interact with tar files in IPFS.",
17 + Tagline: "Utility functions for tar files in ipfs.",
18 },
19
20 Subcommands: map[string]*cmds.Command{
@@ -80,7 +80,7 @@ var tarCatCmd = &cmds.Command{
80 },
81
82 Arguments: []cmds.Argument{
83 - cmds.StringArg("path", true, false, "IPFS path of archive to export.").EnableStdin(),
83 + cmds.StringArg("path", true, false, "ipfs path of archive to export.").EnableStdin(),
84 },
85 Run: func(req cmds.Request, res cmds.Response) {
86 nd, err := req.InvocContext().GetNode()
core/commands/tour_test.go
+1 -1
@@ -13,7 +13,7 @@ func TestParseTourTemplate(t *testing.T) {
13 Content: tour.Content{
14 Title: "IPFS CLI test files",
15 Text: `
16 -Welcome to the IPFS test files
16 +Welcome to the ipfs test files
17 This is where we test our beautiful command line interfaces
18 `,
19 },
core/commands/unixfs/unixfs.go
+3 -3
@@ -4,15 +4,15 @@ import cmds "github.com/ipfs/go-ipfs/commands"
4
5 var UnixFSCmd = &cmds.Command{
6 Helptext: cmds.HelpText{
7 - Tagline: "Interact with ipfs objects representing Unix filesystems.",
7 + Tagline: "Interact with IPFS objects representing Unix filesystems.",
8 ShortDescription: `
9 'ipfs file' provides a familiar interface to file systems represented
10 -by IPFS objects, which hides IPFS implementation details like layout
10 +by IPFS objects, which hides ipfs implementation details like layout
11 objects (e.g. fanout and chunking).
12 `,
13 LongDescription: `
14 'ipfs file' provides a familiar interface to file systems represented
15 -by IPFS objects, which hides IPFS implementation details like layout
15 +by IPFS objects, which hides ipfs implementation details like layout
16 objects (e.g. fanout and chunking).
17 `,
18 },
docs/implement-api-bindings.md
+1 -1
@@ -13,7 +13,7 @@ Sections:
13 IPFS uses a set of type value that is useful to enumerate up front:
14
15 - `<ipfs-path>` is unix-style path, beginning with `/ipfs/<hash>/...` or `/ipns/<hash>/...` or `/ipns/<domain>/...`.
16 -- `<hash>` is a base58 encoded [multihash](https://github.com/jbenet/multihash) (there are [many implementations](https://github.com/jbenet/multihash#implementations)). Usually the hash of an ipfs object (or merkle dag node).
16 +- `<hash>` is a base58 encoded [multihash](https://github.com/jbenet/multihash) (there are [many implementations](https://github.com/jbenet/multihash#implementations)). Usually the hash of an IPFS object (or merkle dag node).
17
18 A note on streams: IPFS is a streaming protocol. Everything about it can be streamed. When importing files, API requests should aim to stream the data in, and handle back-pressure correctly, so that the IPFS node can handle it sequentially without too much memory pressure. (If using HTTP, this is typically handled for you by writes to the request body blocking.)
19
test/bench/bench_cli_ipfs_add/main.go
+1 -1
@@ -16,7 +16,7 @@ import (
16 )
17
18 var (
19 - debug = flag.Bool("debug", false, "direct IPFS output to console")
19 + debug = flag.Bool("debug", false, "direct ipfs output to console")
20 online = flag.Bool("online", false, "run the benchmarks with a running daemon")
21 )
22