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

Clarify the differences between all the file APIs. #7755

Merged
merged 9 commits into from
Nov 24, 2020
Merged

Clarify the differences between all the file APIs. #7755

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d4cd378
Clarify why ipfs file ls is being deprecated.
ChaituVR Nov 7, 2020
c6fe39a
Explain that ipfs ls works on IPFS paths, and ipfs files ls works on …
ChaituVR Nov 7, 2020
0c4ad11
Update files.go
ChaituVR Nov 16, 2020
475e0ea
Update ls.go
ChaituVR Nov 16, 2020
fa81f2a
Update core/commands/files.go
ChaituVR Nov 24, 2020
1cfd8c7
Update core/commands/unixfs/ls.go
ChaituVR Nov 24, 2020
ec64dc5
Update ls.go
ChaituVR Nov 24, 2020
8487fad
Update ls.go
ChaituVR Nov 24, 2020
f46891e
Update ls.go
ChaituVR Nov 24, 2020
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
2 changes: 1 addition & 1 deletion core/commands/files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ var filesLsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List directories in the local mutable namespace.",
ShortDescription: `
List directories in the local mutable namespace.
List directories in the local mutable namespace (works on both IPFS and MFS paths).

Examples:

Expand Down
10 changes: 5 additions & 5 deletions core/commands/unixfs/ls.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@ type LsOutput struct {

var LsCmd = &cmds.Command{
Helptext: cmds.HelpText{
Tagline: "List directory contents for Unix filesystem objects.",
Tagline: "List directory contents for Unix filesystem objects. Deprecated: Use 'ipfs ls' instead.",
ShortDescription: `
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.
This functionality is deprecated, and will be removed in future versions as it duplicates the functionality of 'ipfs ls'.
If possible, please use 'ipfs ls' instead.
`,
LongDescription: `
Displays the contents of an IPFS or IPNS object(s) at the given path.
Expand All @@ -62,8 +62,8 @@ Example:
> 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.
This functionality is deprecated, and will be removed in future versions as it duplicates the functionality of 'ipfs ls'.
If possible, please use 'ipfs ls' instead.
`,
},

Expand Down