opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-08-06 19:44:01 +08:00
Code Issues Projects Releases Wiki Activity

Improve command documentation for listing commands (Fixes #3057).

Browse Source 
* Document deprecation of 'ipfs file' in command help.
* Be explicit about 'ipfs ls' listing unixfs and suplying type in JSON.
* Amend description for 'ipfs files ls'.

License: MIT
Signed-off-by: Mathijs de Bruin <mathijs@mathijsfietst.nl>
This commit is contained in:
Mathijs de Bruin
2016-08-13 09:56:15 +02:00
parent 685cd28dc8
commit 0aad342306
3 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
core/commands/unixfs/ls.go
View File

@ -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.
@ -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.
`,
},