From 3a3c168fe9cd1096485c97a94aa3f49a88cd034f Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Fri, 1 Jul 2016 18:36:55 +0100 Subject: [PATCH] Changed so only explicit ipfs cli commands are lowercased License: MIT Signed-off-by: Richard Littauer --- blocks/blocks.go | 2 +- cmd/ipfs/daemon.go | 6 +++--- cmd/ipfs/init.go | 2 +- cmd/ipfs/main.go | 2 +- core/commands/active.go | 2 +- core/commands/block.go | 4 ++-- core/commands/commands.go | 2 +- core/commands/config.go | 2 +- core/commands/mount_unix.go | 8 ++++---- core/commands/repo.go | 2 +- core/commands/root.go | 6 +++--- core/commands/stat.go | 6 +++--- core/commands/swarm.go | 4 ++-- core/commands/tour_test.go | 2 +- core/core.go | 4 ++-- core/corehttp/gateway_handler.go | 2 +- core/pathresolver.go | 2 +- exchange/bitswap/bitswap.go | 4 ++-- exchange/interface.go | 2 +- fuse/readonly/mount_unix.go | 2 +- fuse/readonly/readonly_unix.go | 2 +- importer/importer.go | 2 +- merkledag/merkledag.go | 2 +- mfs/system.go | 2 +- namesys/namesys.go | 4 ++-- path/path.go | 2 +- repo/config/bootstrap_peers.go | 2 +- repo/config/config.go | 2 +- repo/config/tour.go | 2 +- repo/fsrepo/fsrepo.go | 2 +- routing/dht/dht.go | 2 +- routing/dht/dht_bootstrap.go | 2 +- tar/format.go | 2 +- test/sharness/t0020-init.sh | 8 ++++---- test/sharness/t0090-get.sh | 2 +- thirdparty/ipfsaddr/ipfsaddr.go | 8 ++++---- tour/all.go | 4 ++-- unixfs/format.go | 2 +- 38 files changed, 59 insertions(+), 59 deletions(-) diff --git a/blocks/blocks.go b/blocks/blocks.go index c41e1323a11..b7e15d435c4 100644 --- a/blocks/blocks.go +++ b/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 diff --git a/cmd/ipfs/daemon.go b/cmd/ipfs/daemon.go index 580d9d644ce..570ced07350 100644 --- a/cmd/ipfs/daemon.go +++ b/cmd/ipfs/daemon.go @@ -51,7 +51,7 @@ 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 over the network. Most applications that use IPFS will do so by @@ -133,9 +133,9 @@ Headers. Options: []cmds.Option{ 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), diff --git a/cmd/ipfs/init.go b/cmd/ipfs/init.go index fe9c48537f9..8ed5dd234e0 100644 --- a/cmd/ipfs/init.go +++ b/cmd/ipfs/init.go @@ -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 } diff --git a/cmd/ipfs/main.go b/cmd/ipfs/main.go index 0a16c36d719..4586dbc7a79 100644 --- a/cmd/ipfs/main.go +++ b/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 diff --git a/core/commands/active.go b/core/commands/active.go index e617be22ee8..14f08afcd23 100644 --- a/core/commands/active.go +++ b/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. `, diff --git a/core/commands/block.go b/core/commands/block.go index fa510b5247b..2a4c9357ba7 100644 --- a/core/commands/block.go +++ b/core/commands/block.go @@ -47,7 +47,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: @@ -84,7 +84,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 is a base58 encoded multihash. diff --git a/core/commands/commands.go b/core/commands/commands.go index e69659caf6f..0f37bb727b9 100644 --- a/core/commands/commands.go +++ b/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 diff --git a/core/commands/config.go b/core/commands/config.go index 16a00f86d52..64e8e7ea7e1 100644 --- a/core/commands/config.go +++ b/core/commands/config.go @@ -33,7 +33,7 @@ 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/mount_unix.go b/core/commands/mount_unix.go index 9c80190fd26..ccc49088aea 100644 --- a/core/commands/mount_unix.go +++ b/core/commands/mount_unix.go @@ -15,9 +15,9 @@ import ( var MountCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Mounts 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). +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. @@ -29,7 +29,7 @@ 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 root will not be listable, as it is virtual. Access known paths directly. @@ -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) { diff --git a/core/commands/repo.go b/core/commands/repo.go index 72d0a842c30..c5155bbc59c 100644 --- a/core/commands/repo.go +++ b/core/commands/repo.go @@ -24,7 +24,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/root.go b/core/commands/root.go index c26e9702b3b..d435efacb41 100644 --- a/core/commands/root.go +++ b/core/commands/root.go @@ -24,7 +24,7 @@ var Root = &cmds.Command{ Subcommands: ` BASIC COMMANDS init Initialize ipfs local configuration - add Add a file to ipfs + add Add a file to IPFS cat Show IPFS object data get Download IPFS objects ls List links from an object @@ -37,7 +37,7 @@ 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 @@ -45,7 +45,7 @@ ADVANCED COMMANDS 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 diff --git a/core/commands/stat.go b/core/commands/stat.go index 0e87734d02d..6be2ba1eac0 100644 --- a/core/commands/stat.go +++ b/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{ diff --git a/core/commands/swarm.go b/core/commands/swarm.go index 61fa01faa3c..a6cefff02a4 100644 --- a/core/commands/swarm.go +++ b/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 diff --git a/core/commands/tour_test.go b/core/commands/tour_test.go index 8274f05d277..f01bbcb043b 100644 --- a/core/commands/tour_test.go +++ b/core/commands/tour_test.go @@ -11,7 +11,7 @@ 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 This is where we test our beautiful command line interfaces diff --git a/core/core.go b/core/core.go index 2d3b3281034..b0e522bd75f 100644 --- a/core/core.go +++ b/core/core.go @@ -437,10 +437,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)) diff --git a/core/corehttp/gateway_handler.go b/core/corehttp/gateway_handler.go index 88b7a85877d..1d45c95468d 100644 --- a/core/corehttp/gateway_handler.go +++ b/core/corehttp/gateway_handler.go @@ -330,7 +330,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 } diff --git a/core/pathresolver.go b/core/pathresolver.go index 555cc3dfadc..7d4be0838ea 100644 --- a/core/pathresolver.go +++ b/core/pathresolver.go @@ -52,7 +52,7 @@ func Resolve(ctx context.Context, n *IpfsNode, p path.Path) (*merkledag.Node, er } } - // 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 n.Resolver.ResolvePath(ctx, p) } diff --git a/exchange/bitswap/bitswap.go b/exchange/bitswap/bitswap.go index c98a98db733..e681091b636 100644 --- a/exchange/bitswap/bitswap.go +++ b/exchange/bitswap/bitswap.go @@ -1,4 +1,4 @@ -// package bitswap implements the IPFS Exchange interface with the BitSwap +// package bitswap implements the IPFS exchange interface with the BitSwap // bilateral exchange protocol. package bitswap @@ -69,7 +69,7 @@ func New(parent context.Context, p peer.ID, network bsnet.BitSwapNetwork, // important to use provided parent context (since it may include important // loggable data). It's probably not a good idea to allow bitswap to be - // coupled to the concerns of the IPFS daemon in this way. + // coupled to the concerns of the ipfs daemon in this way. // // FIXME(btc) Now that bitswap manages itself using a process, it probably // shouldn't accept a context anymore. Clients should probably use Close() diff --git a/exchange/interface.go b/exchange/interface.go index 6db476d9ec2..259f764803d 100644 --- a/exchange/interface.go +++ b/exchange/interface.go @@ -1,4 +1,4 @@ -// package exchange defines the IPFS Exchange interface +// package exchange defines the IPFS exchange interface package exchange import ( diff --git a/fuse/readonly/mount_unix.go b/fuse/readonly/mount_unix.go index db07a91107e..ab794545629 100644 --- a/fuse/readonly/mount_unix.go +++ b/fuse/readonly/mount_unix.go @@ -8,7 +8,7 @@ import ( mount "github.com/ipfs/go-ipfs/fuse/mount" ) -// Mount mounts ipfs at a given location, and returns a mount.Mount instance. +// Mount mounts IPFS at a given location, and returns a mount.Mount instance. func Mount(ipfs *core.IpfsNode, mountpoint string) (mount.Mount, error) { cfg, err := ipfs.Repo.Config() if err != nil { diff --git a/fuse/readonly/readonly_unix.go b/fuse/readonly/readonly_unix.go index 3333a41d447..4b40bfa7b0a 100644 --- a/fuse/readonly/readonly_unix.go +++ b/fuse/readonly/readonly_unix.go @@ -24,7 +24,7 @@ import ( var log = logging.Logger("fuse/ipfs") -// FileSystem is the readonly Ipfs Fuse Filesystem. +// FileSystem is the readonly IPFS Fuse Filesystem. type FileSystem struct { Ipfs *core.IpfsNode } diff --git a/importer/importer.go b/importer/importer.go index 190500ba903..d19a6779fef 100644 --- a/importer/importer.go +++ b/importer/importer.go @@ -1,4 +1,4 @@ -// package importer implements utilities used to create ipfs DAGs from files +// package importer implements utilities used to create IPFS DAGs from files // and readers package importer diff --git a/merkledag/merkledag.go b/merkledag/merkledag.go index 7d601d86d38..b85b64e9b16 100644 --- a/merkledag/merkledag.go +++ b/merkledag/merkledag.go @@ -1,4 +1,4 @@ -// package merkledag implements the ipfs Merkle DAG datastructures. +// package merkledag implements the IPFS Merkle DAG datastructures. package merkledag import ( diff --git a/mfs/system.go b/mfs/system.go index 56891cc215b..801a631a684 100644 --- a/mfs/system.go +++ b/mfs/system.go @@ -1,4 +1,4 @@ -// package mfs implements an in memory model of a mutable ipfs filesystem. +// package mfs implements an in memory model of a mutable IPFS filesystem. // // It consists of four main structs: // 1) The Filesystem diff --git a/namesys/namesys.go b/namesys/namesys.go index 699cc5327ad..54e9f21fc76 100644 --- a/namesys/namesys.go +++ b/namesys/namesys.go @@ -14,11 +14,11 @@ import ( // mpns (a multi-protocol NameSystem) implements generic IPFS naming. // // Uses several Resolvers: -// (a) ipfs routing naming: SFS-like PKI names. +// (a) IPFS routing naming: SFS-like PKI names. // (b) dns domains: resolves using links in DNS TXT records // (c) proquints: interprets string as the raw byte data. // -// It can only publish to: (a) ipfs routing naming. +// It can only publish to: (a) IPFS routing naming. // type mpns struct { resolvers map[string]resolver diff --git a/path/path.go b/path/path.go index 790168de092..773540e9dcb 100644 --- a/path/path.go +++ b/path/path.go @@ -12,7 +12,7 @@ import ( ) // ErrBadPath is returned when a given path is incorrectly formatted -var ErrBadPath = errors.New("invalid ipfs ref path") +var ErrBadPath = errors.New("invalid 'ipfs ref' path") // TODO: debate making this a private struct wrapped in a public interface // would allow us to control creation, and cache segments. diff --git a/repo/config/bootstrap_peers.go b/repo/config/bootstrap_peers.go index db6bad2e662..788112ec0aa 100644 --- a/repo/config/bootstrap_peers.go +++ b/repo/config/bootstrap_peers.go @@ -8,7 +8,7 @@ import ( ) // DefaultBootstrapAddresses are the hardcoded bootstrap addresses -// for ipfs. they are nodes run by the ipfs team. docs on these later. +// for IPFS. they are nodes run by the IPFS team. docs on these later. // As with all p2p networks, bootstrap is an important security concern. // // NOTE: This is here -- and not inside cmd/ipfs/init.go -- because of an diff --git a/repo/config/config.go b/repo/config/config.go index d367ac30421..898cf56a472 100644 --- a/repo/config/config.go +++ b/repo/config/config.go @@ -15,7 +15,7 @@ import ( var log = logging.Logger("config") -// Config is used to load IPFS config files. +// Config is used to load ipfs config files. type Config struct { Identity Identity // local node's peer identity Datastore Datastore // local node's storage diff --git a/repo/config/tour.go b/repo/config/tour.go index cf9aef35502..e22d8453f51 100644 --- a/repo/config/tour.go +++ b/repo/config/tour.go @@ -1,6 +1,6 @@ package config -// Tour stores the ipfs tour read-list and resume point +// Tour stores the 'ipfs tour' read-list and resume point type Tour struct { Last string // last tour topic read // Done []string // all topics done so far diff --git a/repo/fsrepo/fsrepo.go b/repo/fsrepo/fsrepo.go index a491541cba7..e3bb9ae324e 100644 --- a/repo/fsrepo/fsrepo.go +++ b/repo/fsrepo/fsrepo.go @@ -55,7 +55,7 @@ type NoRepoError struct { var _ error = NoRepoError{} func (err NoRepoError) Error() string { - return fmt.Sprintf("no ipfs repo found in %s.\nplease run: ipfs init", err.Path) + return fmt.Sprintf("no IPFS repo found in %s.\nplease run: 'ipfs init'", err.Path) } const apiFile = "api" diff --git a/routing/dht/dht.go b/routing/dht/dht.go index 6de362e13cd..8dbc9b62a31 100644 --- a/routing/dht/dht.go +++ b/routing/dht/dht.go @@ -1,4 +1,4 @@ -// Package dht implements a distributed hash table that satisfies the ipfs routing +// Package dht implements a distributed hash table that satisfies the IPFS routing // interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications. package dht diff --git a/routing/dht/dht_bootstrap.go b/routing/dht/dht_bootstrap.go index 46f549ab9c2..0a04b4aa284 100644 --- a/routing/dht/dht_bootstrap.go +++ b/routing/dht/dht_bootstrap.go @@ -1,4 +1,4 @@ -// Package dht implements a distributed hash table that satisfies the ipfs routing +// Package dht implements a distributed hash table that satisfies the IPFS routing // interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications. package dht diff --git a/tar/format.go b/tar/format.go index cbdd2504017..2a433d26dd2 100644 --- a/tar/format.go +++ b/tar/format.go @@ -198,7 +198,7 @@ func (tr *tarReader) Read(b []byte) (int, error) { func ExportTar(ctx context.Context, root *dag.Node, ds dag.DAGService) (io.Reader, error) { if string(root.Data()) != "ipfs/tar" { - return nil, errors.New("not an ipfs tarchive") + return nil, errors.New("not an IPFS tarchive") } return &tarReader{ links: root.Links, diff --git a/test/sharness/t0020-init.sh b/test/sharness/t0020-init.sh index 7bb98f0dd9a..f5d68f591cb 100755 --- a/test/sharness/t0020-init.sh +++ b/test/sharness/t0020-init.sh @@ -45,8 +45,8 @@ test_expect_success "ipfs cat fails" ' ' test_expect_success "ipfs cat no repo message looks good" ' - echo "Error: no ipfs repo found in $IPFS_PATH." > cat_fail_exp && - echo "please run: ipfs init" >> cat_fail_exp && + echo "Error: no IPFS repo found in $IPFS_PATH." > cat_fail_exp && + echo "please run: 'ipfs init'" >> cat_fail_exp && test_path_cmp cat_fail_exp cat_fail_out ' @@ -80,7 +80,7 @@ test_expect_success "ipfs peer id looks good" ' test_expect_success "ipfs init output looks good" ' STARTFILE="ipfs cat /ipfs/$HASH_WELCOME_DOCS/readme" && - echo "initializing ipfs node at $IPFS_PATH" >expected && + echo "initializing IPFS node at $IPFS_PATH" >expected && echo "generating $BITS-bit RSA keypair...done" >>expected && echo "peer identity: $PEERID" >>expected && echo "to get started, enter:" >>expected && @@ -107,7 +107,7 @@ test_expect_success "ipfs peer id looks good" ' ' test_expect_success "'ipfs init --empty-repo' output looks good" ' - echo "initializing ipfs node at $IPFS_PATH" >expected && + echo "initializing IPFS node at $IPFS_PATH" >expected && echo "generating $BITS-bit RSA keypair...done" >>expected && echo "peer identity: $PEERID" >>expected && test_cmp expected actual_init diff --git a/test/sharness/t0090-get.sh b/test/sharness/t0090-get.sh index 3b60a360fd7..193bd56d2bd 100755 --- a/test/sharness/t0090-get.sh +++ b/test/sharness/t0090-get.sh @@ -107,7 +107,7 @@ test_get_cmd() { ' test_expect_success "ipfs get ../.. should fail" ' - echo "Error: invalid ipfs ref path" >expected && + echo "Error: invalid 'ipfs ref' path" >expected && test_must_fail ipfs get ../.. 2>actual && test_cmp expected actual ' diff --git a/thirdparty/ipfsaddr/ipfsaddr.go b/thirdparty/ipfsaddr/ipfsaddr.go index d56c354757d..c87ffaa18c6 100644 --- a/thirdparty/ipfsaddr/ipfsaddr.go +++ b/thirdparty/ipfsaddr/ipfsaddr.go @@ -12,8 +12,8 @@ import ( var log = logging.Logger("ipfsaddr") -// ErrInvalidAddr signals an address is not a valid ipfs address. -var ErrInvalidAddr = errors.New("invalid ipfs address") +// ErrInvalidAddr signals an address is not a valid IPFS address. +var ErrInvalidAddr = errors.New("invalid IPFS address") type IPFSAddr interface { ID() peer.ID @@ -83,7 +83,7 @@ func ParseMultiaddr(m ma.Multiaddr) (a IPFSAddr, err error) { return nil, ErrInvalidAddr } - // make sure it's an ipfs addr + // make sure it's an IPFS addr parts := ma.Split(m) if len(parts) < 1 { return nil, ErrInvalidAddr @@ -93,7 +93,7 @@ func ParseMultiaddr(m ma.Multiaddr) (a IPFSAddr, err error) { return nil, ErrInvalidAddr } - // make sure ipfs id parses as a peer.ID + // make sure 'ipfs id' parses as a peer.ID peerIdParts := path.SplitList(ipfspart.String()) peerIdStr := peerIdParts[len(peerIdParts)-1] id, err := peer.IDB58Decode(peerIdStr) diff --git a/tour/all.go b/tour/all.go index 2dd1bb50b3a..7fe0f4b863c 100644 --- a/tour/all.go +++ b/tour/all.go @@ -182,11 +182,11 @@ var NodeBasicsInit = Content{ // TODO touch on PKI // - // This is somewhat relevant at ipfs init since the generated key pair is the + // This is somewhat relevant at 'ipfs init' since the generated key pair is the // basis for the node's identity in the network. A cursory nod may be // sufficient at that stage, and goes a long way in explaining init's raison // d'être. - // NB: user is introduced to ipfs init before ipfs add. + // NB: user is introduced to 'ipfs init' before 'ipfs add'. Text: ` `, } diff --git a/unixfs/format.go b/unixfs/format.go index 0235f0c7c73..6cf41683545 100644 --- a/unixfs/format.go +++ b/unixfs/format.go @@ -1,4 +1,4 @@ -// Package format implements a data format for files in the ipfs filesystem It +// Package format implements a data format for files in the IPFS filesystem It // is not the only format in ipfs, but it is the one that the filesystem // assumes package unixfs