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 <[email protected]>
ipfs · Jun 27, 2016 · 5903f0e · 5903f0e
1 parent f182675
commit 5903f0e
Show file tree

Hide file tree

Showing 15 changed files with 32 additions and 32 deletions.
diff --git a/cmd/ipfs/daemon.go b/cmd/ipfs/daemon.go
@@ -48,9 +48,9 @@ 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
+'ipfs daemon' runs a persistent ipfs daemon that can serve commands
 over the network. Most applications that use IPFS will do so by
 communicating with a daemon over the HTTP API. While the daemon is
 running, calls to 'ipfs' commands will be sent over the network to
@@ -81,7 +81,7 @@ make sure to protect the port as you would other services or database
 
 HTTP Headers
 
-IPFS supports passing arbitrary headers to the API and Gateway. You can
+ipfs supports passing arbitrary headers to the API and Gateway. You can
 do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
 keys:
 
@@ -117,7 +117,7 @@ environment variable:
 
 DEPRECATION NOTICE
 
-Previously, IPFS used an environment variable as seen below:
+Previously, ipfs used an environment variable as seen below:
 
    export API_ORIGIN="http://localhost:8888/"
 
@@ -128,11 +128,11 @@ Headers.
 	},
 
 	Options: []cmds.Option{
-		cmds.BoolOption(initOptionKwd, "Initialize IPFS with default settings if not already initialized").Default(false),
+		cmds.BoolOption(initOptionKwd, "Initialize ipfs with default settings if not already initialized").Default(false),
 		cmds.StringOption(routingOptionKwd, "Overrides the routing option").Default("dht"),
-		cmds.BoolOption(mountKwd, "Mounts IPFS to the filesystem").Default(false),
+		cmds.BoolOption(mountKwd, "Mounts ipfs to the filesystem").Default(false),
 		cmds.BoolOption(writableKwd, "Enable writing objects (with POST, PUT and DELETE)").Default(false),
-		cmds.StringOption(ipfsMountKwd, "Path to the mountpoint for IPFS (if using --mount). Defaults to config setting."),
+		cmds.StringOption(ipfsMountKwd, "Path to the mountpoint for ipfs (if using --mount). Defaults to config setting."),
 		cmds.StringOption(ipnsMountKwd, "Path to the mountpoint for IPNS (if using --mount). Defaults to config setting."),
 		cmds.BoolOption(unrestrictedApiAccessKwd, "This option has no effect since v0.4.3").Default(false),
 		cmds.BoolOption(unencryptTransportKwd, "Disable transport encryption (for debugging protocols)").Default(false),
@@ -200,7 +200,7 @@ func daemonFunc(req cmds.Request, res cmds.Response) {
 
 	if initialize {
 
-		// now, FileExists is our best method of detecting whether IPFS is
+		// now, FileExists is our best method of detecting whether ipfs is
 		// configured. Consider moving this into a config helper method
 		// `IsInitialized` where the quality of the signal can be improved over
 		// time, and many call-sites can benefit.

diff --git a/cmd/ipfs/init.go b/cmd/ipfs/init.go
@@ -23,9 +23,9 @@ const (
 
 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.
+Initializes ipfs configuration files and generates a new keypair.
 
 ipfs uses a repository in the local file system. By default, the repo is
 located at ~/.ipfs. To change the repo location, set the $IPFS_PATH

diff --git a/core/commands/add.go b/core/commands/add.go
@@ -61,7 +61,7 @@ You can now refer to the added file in a gateway, like so:
 	},
 
 	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)

diff --git a/core/commands/block.go b/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 retrieving 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 retrieving raw ipfs blocks.
 It outputs to stdout, and <key> is a base58 encoded multihash.
@@ -103,15 +103,15 @@ 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.
 `,
 	},
 
 	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()

diff --git a/core/commands/cat.go b/core/commands/cat.go
@@ -20,7 +20,7 @@ var CatCmd = &cmds.Command{
 	},
 
 	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()

diff --git a/core/commands/config.go b/core/commands/config.go
@@ -24,15 +24,15 @@ type ConfigField struct {
 
 var ConfigCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Get and set IPFS config values.",
+		Tagline: "Get and set ipfs config values.",
 		ShortDescription: `
 'ipfs config' controls configuration variables. It works like 'git config'.
-The configuration values are stored in a config file inside your IPFS
+The configuration values are stored in a config file inside your ipfs
 repository.`,
 		LongDescription: `
 'ipfs config' controls configuration variables. It works
 much like 'git config'. The configuration values are stored in a config
-file inside your IPFS repository.
+file inside your ipfs repository.
 
 Examples:
 

diff --git a/core/commands/id.go b/core/commands/id.go
@@ -40,7 +40,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 information for local peers.

diff --git a/core/commands/mount_nofuse.go b/core/commands/mount_nofuse.go
@@ -9,7 +9,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

diff --git a/core/commands/mount_unix.go b/core/commands/mount_unix.go
@@ -15,7 +15,7 @@ import (
 
 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>]
 `,
@@ -74,7 +74,7 @@ baz
 `,
 	},
 	Options: []cmds.Option{
-		cmds.StringOption("ipfs-path", "f", "The path where IPFS 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) {

diff --git a/core/commands/publish.go b/core/commands/publish.go
@@ -47,7 +47,7 @@ Publish an <ipfs-path> to another public key (not implemented):
 	},
 
 	Arguments: []cmds.Argument{
-		cmds.StringArg("ipfs-path", true, false, "IPFS path of the object to be published.").EnableStdin(),
+		cmds.StringArg("ipfs-path", true, false, "ipfs path of the object to be published.").EnableStdin(),
 	},
 	Options: []cmds.Option{
 		cmds.BoolOption("resolve", "Resolve given path before publishing.").Default(true),

diff --git a/core/commands/repo.go b/core/commands/repo.go
@@ -20,7 +20,7 @@ type RepoVersion struct {
 
 var RepoCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Manipulate the IPFS repo.",
+		Tagline: "Manipulate the ipfs repo.",
 		ShortDescription: `
 'ipfs repo' is a plumbing command used to manipulate the repo.
 `,

diff --git a/core/commands/tar.go b/core/commands/tar.go
@@ -13,7 +13,7 @@ import (
 
 var TarCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Utility functions for tar files in IPFS.",
+		Tagline: "Utility functions for tar files in ipfs.",
 	},
 
 	Subcommands: map[string]*cmds.Command{
@@ -83,7 +83,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()

diff --git a/core/commands/tour_test.go b/core/commands/tour_test.go
@@ -13,7 +13,7 @@ func TestParseTourTemplate(t *testing.T) {
 		Content: tour.Content{
 			Title: "IPFS CLI test files",
 			Text: `
-Welcome to the IPFS test files
+Welcome to the ipfs test files
 This is where we test our beautiful command line interfaces
 		`,
 		},

diff --git a/core/commands/unixfs/unixfs.go b/core/commands/unixfs/unixfs.go
@@ -8,12 +8,12 @@ var UnixFSCmd = &cmds.Command{
     Synopsis: "ipfs file <command>",
 		ShortDescription: `
 'ipfs file' provides a familiar interface to file systems represented
-by IPFS objects, which hides IPFS implementation details like layout
+by ipfs objects, which hides ipfs implementation details like layout
 objects (e.g. fanout and chunking).
 `,
     LongDescription: `
 'ipfs file' provides a familiar interface to file systems represented
-by IPFS objects, which hides IPFS implementation details like layout
+by ipfs objects, which hides ipfs implementation details like layout
 objects (e.g. fanout and chunking).
 `,
 	},

diff --git a/test/bench/bench_cli_ipfs_add/main.go b/test/bench/bench_cli_ipfs_add/main.go
@@ -16,7 +16,7 @@ import (
 )
 
 var (
-	debug  = flag.Bool("debug", false, "direct IPFS output to console")
+	debug  = flag.Bool("debug", false, "direct ipfs output to console")
 	online = flag.Bool("online", false, "run the benchmarks with a running daemon")
 )