Merge pull request #2911 from ipfs/feature/ifps-capitalize

docs: decapitalize IPFS where possible

blocks/blocks.go

@@ -1,4 +1,4 @@
-// package blocks contains the lowest level of ipfs data structures,
+// package blocks contains the lowest level of IPFS data structures,
 // the raw block with a checksum.
 package blocks
 

cmd/ipfs/daemon.go

@@ -56,7 +56,7 @@ var daemonCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		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
@@ -87,7 +87,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:
 
@@ -134,7 +134,7 @@ This will later be transitioned into a config option once it gets out of the
 
 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/"
 
@@ -145,7 +145,7 @@ 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(writableKwd, "Enable writing objects (with POST, PUT and DELETE)").Default(false),
@@ -226,7 +226,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.

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
@@ -112,7 +112,7 @@ func initWithDefaults(out io.Writer, repoRoot string) error {
 }
 
 func doInit(out io.Writer, repoRoot string, empty bool, nBitsForKeypair int, conf *config.Config) error {
-	if _, err := fmt.Fprintf(out, "initializing ipfs node at %s\n", repoRoot); err != nil {
+	if _, err := fmt.Fprintf(out, "initializing IPFS node at %s\n", repoRoot); err != nil {
 		return err
 	}
 

cmd/ipfs/main.go

@@ -381,7 +381,7 @@ func commandDetails(path []string, root *cmds.Command) (*cmdDetails, error) {
 }
 
 // commandShouldRunOnDaemon determines, from commmand details, whether a
-// command ought to be executed on an IPFS daemon.
+// command ought to be executed on an ipfs daemon.
 //
 // It returns a client if the command should be executed on a daemon and nil if
 // it should be executed on a client. It returns an error if the command must

core/commands/active.go

@@ -13,7 +13,7 @@ import (
 
 var ActiveReqsCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "List commands run on this ipfs node.",
+		Tagline: "List commands run on this IPFS node.",
 		ShortDescription: `
 Lists running and recently run commands.
 `,

core/commands/add.go

@@ -66,7 +66,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)

core/commands/block.go

@@ -29,7 +29,7 @@ var BlockCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Interact with raw IPFS blocks.",
 		ShortDescription: `
-'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
+'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
 multihash.
 `,
@@ -48,7 +48,7 @@ var blockStatCmd = &cmds.Command{
 		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:
+on raw IPFS blocks. It outputs the following to stdout:
 
 	Key  - the base58 encoded multihash
 	Size - the size of the block in bytes
@@ -84,7 +84,7 @@ var blockGetCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Get a raw IPFS block.",
 		ShortDescription: `
-'ipfs block get' is a plumbing command for retrieving raw ipfs blocks.
+'ipfs block get' is a plumbing command for retrieving raw IPFS blocks.
 It outputs to stdout, and <key> is a base58 encoded multihash.
 `,
 	},
@@ -107,7 +107,7 @@ var blockPutCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Store input as an IPFS block.",
 		ShortDescription: `
-'ipfs block put' is a plumbing command for storing raw ipfs blocks.
+'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/commands.go

@@ -1,4 +1,4 @@
-// Package commands implements the IPFS command interface
+// Package commands implements the ipfs command interface
 //
 // Using github.com/ipfs/go-ipfs/commands to define the command line and HTTP
 // APIs.  This is the interface available to folks using IPFS from outside of

core/commands/config.go

@@ -26,10 +26,10 @@ 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

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.

core/commands/mount_nofuse.go

@@ -9,7 +9,7 @@ import (
 
 var MountCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Mount 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

@@ -15,10 +15,10 @@ import (
 
 var MountCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Mount IPFS to the filesystem (read-only).",
+		Tagline: "Mounts IPFS to the filesystem (read-only).",
 		ShortDescription: `
-Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
-All ipfs objects will be accessible under that directory. Note that the
+Mount IPFS at a read-only mountpoint on the OS (default: /ipfs and /ipns).
+All IPFS objects will be accessible under that directory. Note that the
 root will not be listable, as it is virtual. Access known paths directly.
 
 You may have to create /ipfs and /ipns before using 'ipfs mount':
@@ -29,9 +29,9 @@ You may have to create /ipfs and /ipns before using 'ipfs mount':
 > ipfs mount
 `,
 		LongDescription: `
-Mount ipfs at a read-only mountpoint on the OS. The default, /ipfs and /ipns,
+Mount IPFS at a read-only mountpoint on the OS. The default, /ipfs and /ipns,
 are set in the configutation file, but can be overriden by the options.
-All ipfs objects will be accessible under this directory. Note that the
+All IPFS objects will be accessible under this directory. Note that the
 root will not be listable, as it is virtual. Access known paths directly.
 
 You may have to create /ipfs and /ipns before using 'ipfs mount':

core/commands/object/diff.go

@@ -21,10 +21,10 @@ var ObjectDiffCmd = &cmds.Command{
 		Tagline: "Display the diff between two ipfs objects.",
 		ShortDescription: `
 'ipfs object diff' is a command used to show the differences between
-two ipfs objects.`,
+two IPFS objects.`,
 		LongDescription: `
 'ipfs object diff' is a command used to show the differences between
-two ipfs objects.
+two IPFS objects.
 
 Example:
 

core/commands/object/object.go

@@ -44,7 +44,7 @@ type Object struct {
 
 var ObjectCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Interact with ipfs objects.",
+		Tagline: "Interact with IPFS objects.",
 		ShortDescription: `
 'ipfs object' is a plumbing command used to manipulate DAG objects
 directly.`,

core/commands/object/patch.go

@@ -115,9 +115,9 @@ the limit will not be respected by the network.
 
 var patchSetDataCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Set the data field of an ipfs object.",
+		Tagline: "Set the data field of an IPFS object.",
 		ShortDescription: `
-Set the data of an ipfs object from stdin or with the contents of a file.
+Set the data of an IPFS object from stdin or with the contents of a file.
 
 Example:
 

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),

core/commands/repo.go

@@ -24,7 +24,7 @@ type RepoVersion struct {
 
 var RepoCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Interact with the IPFS repo.",
+		Tagline: "Manipulate the IPFS repo.",
 		ShortDescription: `
 'ipfs repo' is a plumbing command used to manipulate the repo.
 `,

core/commands/root.go

@@ -25,9 +25,9 @@ var Root = &cmds.Command{
 		Subcommands: `
 BASIC COMMANDS
   init          Initialize ipfs local configuration
-  add <path>    Add a file to ipfs
-  cat <ref>     Show ipfs object data
-  get <ref>     Download ipfs objects
+  add <path>    Add a file to IPFS
+  cat <ref>     Show IPFS object data
+  get <ref>     Download IPFS objects
   ls <ref>      List links from an object
   refs <ref>    List hashes of links from an object
 
@@ -38,15 +38,15 @@ DATA STRUCTURE COMMANDS
 
 ADVANCED COMMANDS
   daemon        Start a long-running daemon process
-  mount         Mount an ipfs read-only mountpoint
+  mount         Mount an IPFS read-only mountpoint
   resolve       Resolve any type of name
   name          Publish or resolve IPNS names
   dns           Resolve DNS links
   pin           Pin objects to local storage
   repo          Manipulate the IPFS repository
 
 NETWORK COMMANDS
-  id            Show info about ipfs peers
+  id            Show info about IPFS peers
   bootstrap     Add or remove bootstrap peers
   swarm         Manage connections to the p2p network
   dht           Query the DHT for values or peers

core/commands/stat.go

@@ -18,12 +18,12 @@ import (
 
 var StatsCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Query ipfs statistics.",
+		Tagline: "Query IPFS statistics.",
 		ShortDescription: `'ipfs stats' is a set of commands to help look at statistics
-for your ipfs node.
+for your IPFS node.
 `,
 		LongDescription: `'ipfs stats' is a set of commands to help look at statistics
-for your ipfs node.`,
+for your IPFS node.`,
 	},
 
 	Subcommands: map[string]*cmds.Command{

core/commands/swarm.go

@@ -209,7 +209,7 @@ var swarmConnectCmd = &cmds.Command{
 		ShortDescription: `
 'ipfs swarm connect' opens a new direct connection to a peer address.
 
-The address format is an ipfs multiaddr:
+The address format is an IPFS multiaddr:
 
 ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
 `,
@@ -274,7 +274,7 @@ var swarmDisconnectCmd = &cmds.Command{
 		Tagline: "Close connection to a given address.",
 		ShortDescription: `
 'ipfs swarm disconnect' closes a connection to a peer address. The address
-format is an ipfs multiaddr:
+format is an IPFS multiaddr:
 
 ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
 

core/commands/tar.go

@@ -14,7 +14,7 @@ import (
 
 var TarCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Interact with tar files in IPFS.",
+		Tagline: "Utility functions for tar files in ipfs.",
 	},
 
 	Subcommands: map[string]*cmds.Command{
@@ -80,7 +80,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()

core/commands/tour_test.go

@@ -11,9 +11,9 @@ func TestParseTourTemplate(t *testing.T) {
 	topic := &tour.Topic{
 		ID: "42",
 		Content: tour.Content{
-			Title: "IPFS CLI test files",
+			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
 		`,
 		},

core/commands/unixfs/unixfs.go

@@ -4,15 +4,15 @@ import cmds "github.com/ipfs/go-ipfs/commands"
 
 var UnixFSCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline: "Interact with ipfs objects representing Unix filesystems.",
+		Tagline: "Interact with IPFS objects representing Unix filesystems.",
 		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).
 `,
 	},

core/core.go

@@ -445,10 +445,10 @@ func (n *IpfsNode) loadID() error {
 
 	cid := cfg.Identity.PeerID
 	if cid == "" {
-		return errors.New("Identity was not set in config (was ipfs init run?)")
+		return errors.New("identity was not set in config (was 'ipfs init' run?)")
 	}
 	if len(cid) == 0 {
-		return errors.New("No peer ID in config! (was ipfs init run?)")
+		return errors.New("no peer ID in config! (was 'ipfs init' run?)")
 	}
 
 	n.Identity = peer.ID(b58.Decode(cid))

core/corehttp/gateway_handler.go

@@ -357,7 +357,7 @@ func (i *gatewayHandler) putHandler(w http.ResponseWriter, r *http.Request) {
 
 	rootPath, err := path.ParsePath(r.URL.Path)
 	if err != nil {
-		webError(w, "putHandler: ipfs path not valid", err, http.StatusBadRequest)
+		webError(w, "putHandler: IPFS path not valid", err, http.StatusBadRequest)
 		return
 	}
 

core/pathresolver.go

@@ -53,7 +53,7 @@ func Resolve(ctx context.Context, nsys namesys.NameSystem, r *path.Resolver, p p
 		}
 	}
 
-	// ok, we have an ipfs path now (or what we'll treat as one)
+	// ok, we have an IPFS path now (or what we'll treat as one)
 	return r.ResolvePath(ctx, p)
 }