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

Jump to bottom

Document listing commands better #3083

Merged
merged 1 commit into from
Aug 16, 2016
Merged

Document listing commands better #3083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions core/commands/files/files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,9 @@ type FilesLsOutput struct {

var FilesLsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List directories.",
Tagline: "List directories in the local mutable namespace.",
ShortDescription: `
List directories.
List directories in the local mutable namespace.

Examples:

Expand Down
8 changes: 5 additions & 3 deletions core/commands/ls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ type LsOutput struct {

var LsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List links from an object.",
Tagline: "List directory contents for Unix filesystem objects.",
ShortDescription: `
Displays the links an IPFS or IPNS object(s) contains, with the following
format:
Displays the contents of an IPFS or IPNS object(s) at the given path, with
the following format:

<link base58 hash> <link size in bytes> <link name>

The JSON output contains type information.
`,
},

Expand Down
6 changes: 6 additions & 0 deletions core/commands/unixfs/ls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ Displays the contents of an IPFS or IPNS object(s) at the given path.
The JSON output contains size information. For files, the child size
is the total size of the file contents. For directories, the child
size is the IPFS link size.

This functionality is deprecated, and will be removed in future versions. If
possible, please use 'ipfs ls' instead.
`,
LongDescription: `
Displays the contents of an IPFS or IPNS object(s) at the given path.
Expand All @@ -59,6 +62,9 @@ Example:
cat.jpg
> ipfs file ls /ipfs/QmW2WQi7j6c7UgJTarActp7tDNikE4B2qXtFCfLPdsgaTQ
cat.jpg

This functionality is deprecated, and will be removed in future versions. If
possible, please use 'ipfs ls' instead.
`,
},

Expand Down