Skip to content

Commit

Permalink
docs: decapitalize IPFS where possible
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
RichardLitt authored and whyrusleeping committed Oct 28, 2016
1 parent 17c629d commit 9aaa743
Show file tree
Hide file tree
Showing 19 changed files with 43 additions and 43 deletions.
16 changes: 8 additions & 8 deletions cmd/ipfs/daemon.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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/"
Expand All @@ -145,11 +145,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, "Allow API access to unlisted hashes").Default(false),
cmds.BoolOption(unencryptTransportKwd, "Disable transport encryption (for debugging protocols)").Default(false),
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions cmd/ipfs/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion core/commands/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
12 changes: 6 additions & 6 deletions core/commands/block.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,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.
`,
Expand All @@ -44,10 +44,10 @@ 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:
on raw IPFS blocks. It outputs the following to stdout:
Key - the base58 encoded multihash
Size - the size of the block in bytes
Expand Down Expand Up @@ -81,9 +81,9 @@ 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.
'ipfs block get' is a plumbing command for retrieving raw IPFS blocks.
It outputs to stdout, and <key> is a base58 encoded multihash.
`,
},
Expand All @@ -106,7 +106,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.
`,
},
Expand Down
6 changes: 3 additions & 3 deletions core/commands/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,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:
Expand Down
2 changes: 1 addition & 1 deletion core/commands/id.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion core/commands/mount_nofuse.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions core/commands/mount_unix.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
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':
Expand All @@ -31,7 +31,7 @@ You may have to create /ipfs and /ipns before using 'ipfs mount':
LongDescription: `
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':
Expand Down Expand Up @@ -71,7 +71,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) {
Expand Down
4 changes: 2 additions & 2 deletions core/commands/object/diff.go
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion core/commands/object/object.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.`,
Expand Down
4 changes: 2 additions & 2 deletions core/commands/object/patch.go
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion core/commands/publish.go
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down
2 changes: 1 addition & 1 deletion core/commands/repo.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
`,
Expand Down
4 changes: 2 additions & 2 deletions core/commands/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ var Root = &cmds.Command{
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
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
Expand Down
4 changes: 2 additions & 2 deletions core/commands/tar.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{
Expand Down Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion core/commands/tour_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
`,
},
Expand Down
6 changes: 3 additions & 3 deletions core/commands/unixfs/unixfs.go
Original file line number Diff line number Diff line change
Expand Up @@ -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).
`,
},
Expand Down
2 changes: 1 addition & 1 deletion docs/implement-api-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Sections:
IPFS uses a set of type value that is useful to enumerate up front:

- `<ipfs-path>` is unix-style path, beginning with `/ipfs/<hash>/...` or `/ipns/<hash>/...` or `/ipns/<domain>/...`.
- `<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).
- `<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).

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

Expand Down
2 changes: 1 addition & 1 deletion test/bench/bench_cli_ipfs_add/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
)

Expand Down

0 comments on commit 9aaa743

Please sign in to comment.