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

docs: fix example for files.write #6943

Merged
merged 2 commits into from
Mar 2, 2020
Merged

docs: fix example for files.write #6943

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
885e112
docs: fix example for files.write
alanshaw Mar 2, 2020
0ddc275
docs: fix typo
alanshaw Mar 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 6 additions & 5 deletions core/commands/files.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -686,22 +686,23 @@ a beginning offset to write to. The entire length of the input will be
written.

If the '--create' option is specified, the file will be created if it does not
exist. Nonexistant intermediate directories will not be created.
exist. Nonexistant intermediate directories will not be created unless the
'--parents' option is specified.

Newly created files will have the same CID version and hash function of the
parent directory unless the --cid-version and --hash options are used.
parent directory unless the '--cid-version' and '--hash' options are used.

Newly created leaves will be in the legacy format (Protobuf) if the
CID version is 0, or raw is the CID version is non-zero. Use of the
--raw-leaves option will override this behavior.
CID version is 0, or raw if the CID version is non-zero. Use of the
'--raw-leaves' option will override this behavior.

If the '--flush' option is set to false, changes will not be propogated to the
merkledag root. This can make operations much faster when doing a large number
of writes to a deeper directory structure.

EXAMPLE:

echo "hello world" | ipfs files write --create /myfs/a/b/file
echo "hello world" | ipfs files write --create --parents /myfs/a/b/file
echo "hello world" | ipfs files write --truncate /myfs/a/b/file

WARNING:
Expand Down