Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: cosmetic fixes of help text #8010

Merged
merged 4 commits into from
Mar 30, 2021
Merged

docs: cosmetic fixes of help text #8010

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ff1cf3
docs: cosmetic fixes of help text
lidel Mar 24, 2021
5fad099
docs: suggest dag/files cmds in place of object
lidel Mar 24, 2021
f914113
docs: ipfs object only works with dag-pb
lidel Mar 24, 2021
090953d
docs: tweak ipfs cmd help
lidel Mar 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,29 +288,34 @@ Basic proof of 'ipfs working' locally:

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
init Initialize local IPFS configuration
add <path> Add a file to IPFS
cat <ref> Show IPFS object data
get <ref> Download IPFS objects
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like we should add, that the file/object isn't only fetched to the local node, but also stored in the current working directory in a new folder which is named after the CID.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind opening a separate PR with your suggestions?
I'd like to keep this one scoped to known fixes and avoid bikeshed :)

ls <ref> List links from an object
refs <ref> List hashes of links from an object

DATA STRUCTURE COMMANDS
dag Interact with IPLD DAG nodes
files Interact with files as if they were a unix filesystem
object Interact with dag-pb objects (deprecated, use 'dag' or 'files')
block Interact with raw blocks in the datastore
object Interact with raw dag nodes
files Interact with objects as if they were a unix filesystem

ADVANCED COMMANDS
daemon Start a long-running daemon process
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Start IPFS as a daemon (process)"

How long doesn't matter for this command to work

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#8010 (comment)

mount Mount an ipfs read-only mount point
mount Mount an IPFS read-only mount point
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, yeah we only support read-only mount points... but I don't think this command is in general limited to this. Also, the sentence is a bit confusing... what is an "IPFS read-only mount point" exactly?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#8010 (comment)

resolve Resolve any type of name
name Publish or resolve IPNS names
name Publish and resolve IPNS names
key Create and list IPNS name keypairs
dns Resolve DNS links
pin Pin objects to local storage
repo Manipulate an IPFS repository
repo Manipulate the IPFS repository
stats Various operational stats
p2p Libp2p stream mounting
filestore Manage the filestore (experimental)

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
Expand All @@ -319,9 +324,11 @@ SUBCOMMANDS

TOOL COMMANDS
config Manage configuration
version Show ipfs version information
version Show IPFS version information
update Download and apply go-ipfs updates
commands List all available commands
cid Convert and discover properties of CIDs
log Manage and show logs of running daemon

Use 'ipfs <command> --help' to learn more about each command.

Expand Down
10 changes: 5 additions & 5 deletions core/commands/add.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ const adderOutChanSize = 8

var AddCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Add a file or directory to ipfs.",
Tagline: "Add a file or directory to IPFS.",
ShortDescription: `
Adds contents of <path> to ipfs. Use -r to add directories (recursively).
Adds contents of <path> to IPFS. Use -r to add directories (recursively).
`,
LongDescription: `
Adds contents of <path> to ipfs. Use -r to add directories.
Note that directories are added recursively, to form the ipfs
Adds contents of <path> to IPFS. Use -r to add directories.
Note that directories are added recursively, to form the IPFS
MerkleDAG.

If the daemon is not running, it will just add locally.
Expand Down Expand Up @@ -115,7 +115,7 @@ only-hash, and progress/status related flags) will change the final hash.
},

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
4 changes: 2 additions & 2 deletions core/commands/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@ const (

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_PATH
repository.`,
LongDescription: `
'ipfs config' controls configuration variables. It works
Expand Down
20 changes: 10 additions & 10 deletions core/commands/dag/dag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ const (
// DagCmd provides a subset of commands for interacting with ipld dag objects
var DagCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Interact with ipld dag objects.",
Tagline: "Interact with IPLD DAG objects.",
ShortDescription: `
'ipfs dag' is used for creating and manipulating dag objects/hierarchies.
'ipfs dag' is used for creating and manipulating DAG objects/hierarchies.

This subcommand is currently an experimental feature, but it is intended
to deprecate and replace the existing 'ipfs object' command moving forward.
Expand Down Expand Up @@ -67,7 +67,7 @@ type RootMeta struct {
// DagPutCmd is a command for adding a dag node
var DagPutCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Add a dag node to ipfs.",
Tagline: "Add a DAG node to IPFS.",
ShortDescription: `
'ipfs dag put' accepts input from a file or stdin and parses it
into an object of the specified format.
Expand Down Expand Up @@ -99,9 +99,9 @@ into an object of the specified format.
// DagGetCmd is a command for getting a dag node from IPFS
var DagGetCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Get a dag node from ipfs.",
Tagline: "Get a DAG node from IPFS.",
ShortDescription: `
'ipfs dag get' fetches a dag node from ipfs and prints it out in the specified
'ipfs dag get' fetches a DAG node from IPFS and prints it out in the specified
format.
`,
},
Expand All @@ -114,9 +114,9 @@ format.
// DagResolveCmd returns address of highest block within a path and a path remainder
var DagResolveCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Resolve ipld block",
Tagline: "Resolve IPLD block.",
ShortDescription: `
'ipfs dag resolve' fetches a dag node from ipfs, prints its address and remaining path.
'ipfs dag resolve' fetches a DAG node from IPFS, prints its address and remaining path.
`,
},
Arguments: []cmds.Argument{
Expand Down Expand Up @@ -230,7 +230,7 @@ var DagExportCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Streams the selected DAG as a .car stream on stdout.",
ShortDescription: `
'ipfs dag export' fetches a dag and streams it out as a well-formed .car file.
'ipfs dag export' fetches a DAG and streams it out as a well-formed .car file.
Note that at present only single root selections / .car files are supported.
The output of blocks happens in strict DAG-traversal, first-seen, order.
`,
Expand Down Expand Up @@ -260,9 +260,9 @@ func (s *DagStat) String() string {
// DagStatCmd is a command for getting size information about an ipfs-stored dag
var DagStatCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Gets stats for a DAG",
Tagline: "Gets stats for a DAG.",
ShortDescription: `
'ipfs dag stat' fetches a dag and returns various statistics about the DAG.
'ipfs dag stat' fetches a DAG and returns various statistics about it.
Statistics include size and number of blocks.

Note: This command skips duplicate blocks in reporting both size and the number of blocks
Expand Down
8 changes: 4 additions & 4 deletions core/commands/files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ import (
"sort"
"strings"

humanize "github.com/dustin/go-humanize"
"github.com/ipfs/go-ipfs/core"
"github.com/ipfs/go-ipfs/core/commands/cmdenv"

"github.com/dustin/go-humanize"
bservice "github.com/ipfs/go-blockservice"
cid "github.com/ipfs/go-cid"
cidenc "github.com/ipfs/go-cidutil/cidenc"
Expand All @@ -22,7 +22,7 @@ import (
ipld "github.com/ipfs/go-ipld-format"
logging "github.com/ipfs/go-log"
dag "github.com/ipfs/go-merkledag"
"github.com/ipfs/go-mfs"
mfs "github.com/ipfs/go-mfs"
ft "github.com/ipfs/go-unixfs"
iface "github.com/ipfs/interface-go-ipfs-core"
path "github.com/ipfs/interface-go-ipfs-core/path"
Expand Down Expand Up @@ -943,9 +943,9 @@ are run with the '--flush=false'.

var filesChcidCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Change the cid version or hash function of the root node of a given path.",
Tagline: "Change the CID version or hash function of the root node of a given path.",
ShortDescription: `
Change the cid version or hash function of the root node of a given path.
Change the CID version or hash function of the root node of a given path.
`,
},
Arguments: []cmds.Argument{
Expand Down
2 changes: 1 addition & 1 deletion core/commands/id.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const (

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
8 changes: 4 additions & 4 deletions core/commands/keystore.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ var keyImportCmd = &cmds.Command{

var keyListCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List all local keypairs",
Tagline: "List all local keypairs.",
},
Options: []cmds.Option{
cmds.BoolOption("l", "Show extra information about keys."),
Expand Down Expand Up @@ -345,7 +345,7 @@ const (

var keyRenameCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Rename a keypair",
Tagline: "Rename a keypair.",
},
Arguments: []cmds.Argument{
cmds.StringArg("name", true, false, "name of key to rename"),
Expand Down Expand Up @@ -396,7 +396,7 @@ var keyRenameCmd = &cmds.Command{

var keyRmCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Remove a keypair",
Tagline: "Remove a keypair.",
},
Arguments: []cmds.Argument{
cmds.StringArg("name", true, true, "names of keys to remove").EnableStdin(),
Expand Down Expand Up @@ -440,7 +440,7 @@ var keyRmCmd = &cmds.Command{

var keyRotateCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Rotates the ipfs identity.",
Tagline: "Rotates the IPFS identity.",
ShortDescription: `
Generates a new ipfs identity and saves it to the ipfs config file.
Your existing identity key will be backed up in the Keystore.
Expand Down
6 changes: 3 additions & 3 deletions core/commands/name/ipnsps.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Note: this command is experimental and subject to change as the system is refine

var ipnspsStateCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Query the state of IPNS pubsub",
Tagline: "Query the state of IPNS pubsub.",
},
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
n, err := cmdenv.GetNode(env)
Expand Down Expand Up @@ -71,7 +71,7 @@ var ipnspsStateCmd = &cmds.Command{

var ipnspsSubsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Show current name subscriptions",
Tagline: "Show current name subscriptions.",
},
Options: []cmds.Option{
ke.OptionIPNSBase,
Expand Down Expand Up @@ -115,7 +115,7 @@ var ipnspsSubsCmd = &cmds.Command{

var ipnspsCancelCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Cancel a name subscription",
Tagline: "Cancel a name subscription.",
},
Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {
n, err := cmdenv.GetNode(env)
Expand Down
2 changes: 1 addition & 1 deletion core/commands/object/diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type Changes struct {

var ObjectDiffCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "Display the diff between two ipfs objects.",
Tagline: "Display the diff between two IPFS objects.",
ShortDescription: `
'ipfs object diff' is a command used to show the differences between
two IPFS objects.`,
Expand Down
Loading