--help: Add a note on using IPFS_PATH to the footer of the helptext. #1981
Conversation
|
There were the following issues with your Pull Request
Guidelines and a script are available to help. Your feedback on GitCop is welcome on this issue. This message was auto-generated by https://gitcop.com |
| @@ -69,6 +69,9 @@ TOOL COMMANDS | |||
| commands List all available commands | |||
|
|
|||
| Use 'ipfs <command> --help' to learn more about each command. | |||
|
|
|||
| If you want to operate on a different repository than the default at ~/.ipfs, | |||
| then prefix any ipfs command with IPFS_PATH=/path. | |||
There was a problem hiding this comment.
I would phrase this a little different, to give the reader a more clear idea of whats going on:
"You may set the IPFS_PATH environment variable to make ipfs use a different location for its on disk repo."
Or something, cc @jbenet @RichardLitt
There was a problem hiding this comment.
@sahib This is a great add! But I agree, it is worded a bit strange. How about:
If you want IPFS to use a different directory locally than the default
~/.ipfs, set theIPFS_PATHenvironment variable to point to your preferred directory.
Sahib, do you know how to amend commits?
There was a problem hiding this comment.
I used your suggestion and updated the pull request.
Sahib, do you know how to amend commits?
I just squashed my commits to one.
(Had to use git push --force but I guess nobody used that commit yet...)
|
LGTM! |
| @@ -69,6 +69,9 @@ TOOL COMMANDS | |||
| commands List all available commands | |||
|
|
|||
| Use 'ipfs <command> --help' to learn more about each command. | |||
|
|
|||
| If you want IPFS to use a different directory locally than the default ~/.ipfs, | |||
| set the IPFS_PATH environment variable to point to your preferred directory. | |||
There was a problem hiding this comment.
How about this (+ example):
ipfs uses a repo (repository) in the local file system. By default, the repo is located
at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:
export IPFS_PATH=/path/to/ipfsrepo
|
LGTM thanks-- one minor edit above. sorry for the delay @sahib |
License: MIT Signed-off-by: Chris P. <sahib@online.de>
|
@jbenet: Changed. Only change from your suggestion was spelling out repository long the first time and abbreviating afterwards. |
|
lgtm. Thanks. |
--help: Add a note on using IPFS_PATH to the footer of the helptext.
|
thanks @sahib ! |
I couldn't find this piece of information in the official docs, just scattered over a few issues on GitHub.