Unverified Commit 373f5f9f authored by Adin Schmahmann's avatar Adin Schmahmann Committed by GitHub

Merge pull request #7755 from ChaituVR/patch-1

* Clarify why ipfs file ls is being deprecated.
* Explain that ipfs files ls works on both IPFS paths and MFS paths.
parents 6e82b53f f46891e0
......@@ -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:
......
......@@ -34,7 +34,7 @@ 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.
......@@ -42,8 +42,8 @@ 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.
......@@ -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.
`,
},
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment