Changed so only explicit ipfs cli commands are lowercased
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jul 1, 2016 at 18:36 UTC
9843e86258102a4d3edf4eec1923097009dbcfab
36 files changed
+57
-57
blocks/blocks.go
+1
-1
@@ -1,4 +1,4 @@
1
-// package blocks contains the lowest level of ipfs data structures,
1
+// package blocks contains the lowest level of IPFS data structures,
2
// the raw block with a checksum.
3
package blocks
4
cmd/ipfs/daemon.go
+3
-3
@@ -54,7 +54,7 @@ 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
60
over the network. Most applications that use IPFS will do so by
@@ -147,9 +147,9 @@ Headers.
147
Options: []cmds.Option{
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),
cmd/ipfs/init.go
+1
-1
@@ -112,7 +112,7 @@ func initWithDefaults(out io.Writer, repoRoot string) error {
112
}
113
114
func doInit(out io.Writer, repoRoot string, empty bool, nBitsForKeypair int, conf *config.Config) error {
115
- if _, err := fmt.Fprintf(out, "initializing ipfs node at %s\n", repoRoot); err != nil {
115
+ if _, err := fmt.Fprintf(out, "initializing IPFS node at %s\n", repoRoot); err != nil {
116
return err
117
}
118
cmd/ipfs/main.go
+1
-1
@@ -381,7 +381,7 @@ func commandDetails(path []string, root *cmds.Command) (*cmdDetails, error) {
381
}
382
383
// commandShouldRunOnDaemon determines, from commmand details, whether a
384
-// command ought to be executed on an IPFS daemon.
384
+// command ought to be executed on an ipfs daemon.
385
//
386
// It returns a client if the command should be executed on a daemon and nil if
387
// it should be executed on a client. It returns an error if the command must
core/commands/active.go
+1
-1
@@ -13,7 +13,7 @@ import (
13
14
var ActiveReqsCmd = &cmds.Command{
15
Helptext: cmds.HelpText{
16
- Tagline: "List commands run on this ipfs node.",
16
+ Tagline: "List commands run on this IPFS node.",
17
ShortDescription: `
18
Lists running and recently run commands.
19
`,
core/commands/block.go
+2
-2
@@ -44,7 +44,7 @@ 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:
@@ -81,7 +81,7 @@ 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.
87
It outputs to stdout, and <key> is a base58 encoded multihash.
core/commands/commands.go
+1
-1
@@ -1,4 +1,4 @@
1
-// Package commands implements the IPFS command interface
1
+// Package commands implements the ipfs command interface
2
//
3
// Using github.com/ipfs/go-ipfs/commands to define the command line and HTTP
4
// APIs. This is the interface available to folks using IPFS from outside of
core/commands/config.go
+1
-1
@@ -34,7 +34,7 @@ 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/mount_unix.go
+4
-4
@@ -15,9 +15,9 @@ import (
15
16
var MountCmd = &cmds.Command{
17
Helptext: cmds.HelpText{
18
- Tagline: "Mounts 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).
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
22
root will not be listable, as it is virtual. Access known paths directly.
23
@@ -29,7 +29,7 @@ You may have to create /ipfs and /ipns before using 'ipfs mount':
29
> ipfs mount
30
`,
31
LongDescription: `
32
-Mount ipfs at a read-only mountpoint on the OS. The default, /ipfs and /ipns,
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
35
root will not be listable, as it is virtual. Access known paths directly.
@@ -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/repo.go
+1
-1
@@ -24,7 +24,7 @@ type RepoVersion struct {
24
25
var RepoCmd = &cmds.Command{
26
Helptext: cmds.HelpText{
27
- Tagline: "Manipulate 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
+3
-3
@@ -24,7 +24,7 @@ var Root = &cmds.Command{
24
Subcommands: `
25
BASIC COMMANDS
26
init Initialize ipfs local configuration
27
- add <path> Add a file to ipfs
27
+ add <path> Add a file to IPFS
28
cat <ref> Show IPFS object data
29
get <ref> Download IPFS objects
30
ls <ref> List links from an object
@@ -37,7 +37,7 @@ DATA STRUCTURE COMMANDS
37
38
ADVANCED COMMANDS
39
daemon Start a long-running daemon process
40
- mount Mount an ipfs read-only mountpoint
40
+ mount Mount an IPFS read-only mountpoint
41
resolve Resolve any type of name
42
name Publish or resolve IPNS names
43
dns Resolve DNS links
@@ -45,7 +45,7 @@ ADVANCED COMMANDS
45
repo Manipulate the IPFS repository
46
47
NETWORK COMMANDS
48
- id Show info about ipfs peers
48
+ id Show info about IPFS peers
49
bootstrap Add or remove bootstrap peers
50
swarm Manage connections to the p2p network
51
dht Query the DHT for values or peers
core/commands/stat.go
+3
-3
@@ -18,12 +18,12 @@ import (
18
19
var StatsCmd = &cmds.Command{
20
Helptext: cmds.HelpText{
21
- Tagline: "Query ipfs statistics.",
21
+ Tagline: "Query IPFS statistics.",
22
ShortDescription: `'ipfs stats' is a set of commands to help look at statistics
23
-for your ipfs node.
23
+for your IPFS node.
24
`,
25
LongDescription: `'ipfs stats' is a set of commands to help look at statistics
26
-for your ipfs node.`,
26
+for your IPFS node.`,
27
},
28
29
Subcommands: map[string]*cmds.Command{
core/commands/swarm.go
+2
-2
@@ -209,7 +209,7 @@ var swarmConnectCmd = &cmds.Command{
209
ShortDescription: `
210
'ipfs swarm connect' opens a new direct connection to a peer address.
211
212
-The address format is an ipfs multiaddr:
212
+The address format is an IPFS multiaddr:
213
214
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
215
`,
@@ -274,7 +274,7 @@ var swarmDisconnectCmd = &cmds.Command{
274
Tagline: "Close connection to a given address.",
275
ShortDescription: `
276
'ipfs swarm disconnect' closes a connection to a peer address. The address
277
-format is an ipfs multiaddr:
277
+format is an IPFS multiaddr:
278
279
ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
280
core/commands/tour_test.go
+1
-1
@@ -11,7 +11,7 @@ func TestParseTourTemplate(t *testing.T) {
11
topic := &tour.Topic{
12
ID: "42",
13
Content: tour.Content{
14
- Title: "IPFS CLI test files",
14
+ Title: "ipfs CLI test files",
15
Text: `
16
Welcome to the ipfs test files
17
This is where we test our beautiful command line interfaces
core/core.go
+2
-2
@@ -445,10 +445,10 @@ func (n *IpfsNode) loadID() error {
445
446
cid := cfg.Identity.PeerID
447
if cid == "" {
448
- return errors.New("Identity was not set in config (was ipfs init run?)")
448
+ return errors.New("identity was not set in config (was 'ipfs init' run?)")
449
}
450
if len(cid) == 0 {
451
- return errors.New("No peer ID in config! (was ipfs init run?)")
451
+ return errors.New("no peer ID in config! (was 'ipfs init' run?)")
452
}
453
454
n.Identity = peer.ID(b58.Decode(cid))
core/corehttp/gateway_handler.go
+1
-1
@@ -357,7 +357,7 @@ func (i *gatewayHandler) putHandler(w http.ResponseWriter, r *http.Request) {
357
358
rootPath, err := path.ParsePath(r.URL.Path)
359
if err != nil {
360
- webError(w, "putHandler: ipfs path not valid", err, http.StatusBadRequest)
360
+ webError(w, "putHandler: IPFS path not valid", err, http.StatusBadRequest)
361
return
362
}
363
core/pathresolver.go
+1
-1
@@ -53,7 +53,7 @@ func Resolve(ctx context.Context, nsys namesys.NameSystem, r *path.Resolver, p p
53
}
54
}
55
56
- // ok, we have an ipfs path now (or what we'll treat as one)
56
+ // ok, we have an IPFS path now (or what we'll treat as one)
57
return r.ResolvePath(ctx, p)
58
}
59
exchange/bitswap/bitswap.go
+2
-2
@@ -1,4 +1,4 @@
1
-// package bitswap implements the IPFS Exchange interface with the BitSwap
1
+// package bitswap implements the IPFS exchange interface with the BitSwap
2
// bilateral exchange protocol.
3
package bitswap
4
@@ -68,7 +68,7 @@ func New(parent context.Context, p peer.ID, network bsnet.BitSwapNetwork,
68
69
// important to use provided parent context (since it may include important
70
// loggable data). It's probably not a good idea to allow bitswap to be
71
- // coupled to the concerns of the IPFS daemon in this way.
71
+ // coupled to the concerns of the ipfs daemon in this way.
72
//
73
// FIXME(btc) Now that bitswap manages itself using a process, it probably
74
// shouldn't accept a context anymore. Clients should probably use Close()
exchange/interface.go
+1
-1
@@ -1,4 +1,4 @@
1
-// package exchange defines the IPFS Exchange interface
1
+// package exchange defines the IPFS exchange interface
2
package exchange
3
4
import (
fuse/readonly/mount_unix.go
+1
-1
@@ -8,7 +8,7 @@ import (
8
mount "github.com/ipfs/go-ipfs/fuse/mount"
9
)
10
11
-// Mount mounts ipfs at a given location, and returns a mount.Mount instance.
11
+// Mount mounts IPFS at a given location, and returns a mount.Mount instance.
12
func Mount(ipfs *core.IpfsNode, mountpoint string) (mount.Mount, error) {
13
cfg, err := ipfs.Repo.Config()
14
if err != nil {
fuse/readonly/readonly_unix.go
+1
-1
@@ -25,7 +25,7 @@ import (
25
26
var log = logging.Logger("fuse/ipfs")
27
28
-// FileSystem is the readonly Ipfs Fuse Filesystem.
28
+// FileSystem is the readonly IPFS Fuse Filesystem.
29
type FileSystem struct {
30
Ipfs *core.IpfsNode
31
}
importer/importer.go
+1
-1
@@ -1,4 +1,4 @@
1
-// package importer implements utilities used to create ipfs DAGs from files
1
+// package importer implements utilities used to create IPFS DAGs from files
2
// and readers
3
package importer
4
merkledag/merkledag.go
+1
-1
@@ -1,4 +1,4 @@
1
-// package merkledag implements the ipfs Merkle DAG datastructures.
1
+// package merkledag implements the IPFS Merkle DAG datastructures.
2
package merkledag
3
4
import (
mfs/system.go
+1
-1
@@ -1,4 +1,4 @@
1
-// package mfs implements an in memory model of a mutable ipfs filesystem.
1
+// package mfs implements an in memory model of a mutable IPFS filesystem.
2
//
3
// It consists of four main structs:
4
// 1) The Filesystem
namesys/namesys.go
+2
-2
@@ -14,11 +14,11 @@ import (
14
// mpns (a multi-protocol NameSystem) implements generic IPFS naming.
15
//
16
// Uses several Resolvers:
17
-// (a) ipfs routing naming: SFS-like PKI names.
17
+// (a) IPFS routing naming: SFS-like PKI names.
18
// (b) dns domains: resolves using links in DNS TXT records
19
// (c) proquints: interprets string as the raw byte data.
20
//
21
-// It can only publish to: (a) ipfs routing naming.
21
+// It can only publish to: (a) IPFS routing naming.
22
//
23
type mpns struct {
24
resolvers map[string]resolver
path/path.go
+1
-1
@@ -9,7 +9,7 @@ import (
9
)
10
11
// ErrBadPath is returned when a given path is incorrectly formatted
12
-var ErrBadPath = errors.New("invalid ipfs ref path")
12
+var ErrBadPath = errors.New("invalid 'ipfs ref' path")
13
14
// TODO: debate making this a private struct wrapped in a public interface
15
// would allow us to control creation, and cache segments.
repo/config/bootstrap_peers.go
+1
-1
@@ -8,7 +8,7 @@ import (
8
)
9
10
// DefaultBootstrapAddresses are the hardcoded bootstrap addresses
11
-// for ipfs. they are nodes run by the ipfs team. docs on these later.
11
+// for IPFS. they are nodes run by the IPFS team. docs on these later.
12
// As with all p2p networks, bootstrap is an important security concern.
13
//
14
// NOTE: This is here -- and not inside cmd/ipfs/init.go -- because of an
repo/config/config.go
+1
-1
@@ -15,7 +15,7 @@ import (
15
16
var log = logging.Logger("config")
17
18
-// Config is used to load IPFS config files.
18
+// Config is used to load ipfs config files.
19
type Config struct {
20
Identity Identity // local node's peer identity
21
Datastore Datastore // local node's storage
repo/config/tour.go
+1
-1
@@ -1,6 +1,6 @@
1
package config
2
3
-// Tour stores the ipfs tour read-list and resume point
3
+// Tour stores the 'ipfs tour' read-list and resume point
4
type Tour struct {
5
Last string // last tour topic read
6
// Done []string // all topics done so far
repo/fsrepo/fsrepo.go
+1
-1
@@ -55,7 +55,7 @@ type NoRepoError struct {
55
var _ error = NoRepoError{}
56
57
func (err NoRepoError) Error() string {
58
- return fmt.Sprintf("no ipfs repo found in %s.\nplease run: ipfs init", err.Path)
58
+ return fmt.Sprintf("no IPFS repo found in %s.\nplease run: 'ipfs init'", err.Path)
59
}
60
61
const apiFile = "api"
tar/format.go
+1
-1
@@ -204,7 +204,7 @@ func (tr *tarReader) Read(b []byte) (int, error) {
204
205
func ExportTar(ctx context.Context, root *dag.ProtoNode, ds dag.DAGService) (io.Reader, error) {
206
if string(root.Data()) != "ipfs/tar" {
207
- return nil, errors.New("not an ipfs tarchive")
207
+ return nil, errors.New("not an IPFS tarchive")
208
}
209
return &tarReader{
210
links: root.Links(),
test/sharness/t0020-init.sh
+4
-4
@@ -45,8 +45,8 @@ test_expect_success "ipfs cat fails" '
45
'
46
47
test_expect_success "ipfs cat no repo message looks good" '
48
- echo "Error: no ipfs repo found in $IPFS_PATH." > cat_fail_exp &&
49
- echo "please run: ipfs init" >> cat_fail_exp &&
48
+ echo "Error: no IPFS repo found in $IPFS_PATH." > cat_fail_exp &&
49
+ echo "please run: 'ipfs init'" >> cat_fail_exp &&
50
test_path_cmp cat_fail_exp cat_fail_out
51
'
52
@@ -80,7 +80,7 @@ test_expect_success "ipfs peer id looks good" '
80
81
test_expect_success "ipfs init output looks good" '
82
STARTFILE="ipfs cat /ipfs/$HASH_WELCOME_DOCS/readme" &&
83
- echo "initializing ipfs node at $IPFS_PATH" >expected &&
83
+ echo "initializing IPFS node at $IPFS_PATH" >expected &&
84
echo "generating $BITS-bit RSA keypair...done" >>expected &&
85
echo "peer identity: $PEERID" >>expected &&
86
echo "to get started, enter:" >>expected &&
@@ -107,7 +107,7 @@ test_expect_success "ipfs peer id looks good" '
107
'
108
109
test_expect_success "'ipfs init --empty-repo' output looks good" '
110
- echo "initializing ipfs node at $IPFS_PATH" >expected &&
110
+ echo "initializing IPFS node at $IPFS_PATH" >expected &&
111
echo "generating $BITS-bit RSA keypair...done" >>expected &&
112
echo "peer identity: $PEERID" >>expected &&
113
test_cmp expected actual_init
test/sharness/t0090-get.sh
+1
-1
@@ -107,7 +107,7 @@ test_get_cmd() {
107
'
108
109
test_expect_success "ipfs get ../.. should fail" '
110
- echo "Error: invalid ipfs ref path" >expected &&
110
+ echo "Error: invalid 'ipfs ref' path" >expected &&
111
test_must_fail ipfs get ../.. 2>actual &&
112
test_cmp expected actual
113
'
thirdparty/ipfsaddr/ipfsaddr.go
+4
-4
@@ -12,8 +12,8 @@ import (
12
13
var log = logging.Logger("ipfsaddr")
14
15
-// ErrInvalidAddr signals an address is not a valid ipfs address.
16
-var ErrInvalidAddr = errors.New("invalid ipfs address")
15
+// ErrInvalidAddr signals an address is not a valid IPFS address.
16
+var ErrInvalidAddr = errors.New("invalid IPFS address")
17
18
type IPFSAddr interface {
19
ID() peer.ID
@@ -83,7 +83,7 @@ func ParseMultiaddr(m ma.Multiaddr) (a IPFSAddr, err error) {
83
return nil, ErrInvalidAddr
84
}
85
86
- // make sure it's an ipfs addr
86
+ // make sure it's an IPFS addr
87
parts := ma.Split(m)
88
if len(parts) < 1 {
89
return nil, ErrInvalidAddr
@@ -93,7 +93,7 @@ func ParseMultiaddr(m ma.Multiaddr) (a IPFSAddr, err error) {
93
return nil, ErrInvalidAddr
94
}
95
96
- // make sure ipfs id parses as a peer.ID
96
+ // make sure 'ipfs id' parses as a peer.ID
97
peerIdParts := path.SplitList(ipfspart.String())
98
peerIdStr := peerIdParts[len(peerIdParts)-1]
99
id, err := peer.IDB58Decode(peerIdStr)
tour/all.go
+2
-2
@@ -182,11 +182,11 @@ var NodeBasicsInit = Content{
182
183
// TODO touch on PKI
184
//
185
- // This is somewhat relevant at ipfs init since the generated key pair is the
185
+ // This is somewhat relevant at 'ipfs init' since the generated key pair is the
186
// basis for the node's identity in the network. A cursory nod may be
187
// sufficient at that stage, and goes a long way in explaining init's raison
188
// d'être.
189
- // NB: user is introduced to ipfs init before ipfs add.
189
+ // NB: user is introduced to 'ipfs init' before 'ipfs add'.
190
Text: `
191
`,
192
}
unixfs/format.go
+1
-1
@@ -1,4 +1,4 @@
1
-// Package format implements a data format for files in the ipfs filesystem It
1
+// Package format implements a data format for files in the IPFS filesystem It
2
// is not the only format in ipfs, but it is the one that the filesystem
3
// assumes
4
package unixfs