Normalised Example heading, added dollar sign to examples
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Feb 4, 2016 at 17:20 UTC
af148b3e0570e0d702bfd220f14adbb485d4d01a
4 files changed
+14
-13
core/commands/config.go
+3
-3
@@ -41,15 +41,15 @@ repository.`,
41
much like 'git config'. The configuration values are stored in a config
42
file inside your IPFS repository.
43
44
-EXAMPLES:
44
+Examples:
45
46
Get the value of the 'datastore.path' key:
47
48
- ipfs config datastore.path
48
+ $ ipfs config datastore.path
49
50
Set the value of the 'datastore.path' key:
51
52
- ipfs config datastore.path ~/.ipfs/datastore
52
+ $ ipfs config datastore.path ~/.ipfs/datastore
53
`,
54
},
55
core/commands/mount_unix.go
+1
-1
@@ -43,7 +43,7 @@ You may have to create /ipfs and /ipns before using 'ipfs mount':
43
> ipfs daemon &
44
> ipfs mount
45
46
-EXAMPLE:
46
+Example:
47
48
# setup
49
> mkdir foo
core/commands/object/object.go
+3
-3
@@ -305,7 +305,7 @@ Data should be in the format specified by the --inputenc flag.
305
306
Examples:
307
308
- echo '{ "Data": "abc" }' | ipfs object put
308
+ $ echo '{ "Data": "abc" }' | ipfs object put
309
310
This creates a node with the data "abc" and no links. For an object with links,
311
create a file named node.json with the contents:
@@ -319,9 +319,9 @@ create a file named node.json with the contents:
319
} ]
320
}
321
322
-and then run
322
+And then run:
323
324
- ipfs object put node.json
324
+ $ ipfs object put node.json
325
`,
326
},
327
core/commands/object/patch.go
+7
-6
@@ -48,7 +48,8 @@ var patchAppendDataCmd = &cmds.Command{
48
ShortDescription: `
49
Append data to what already exists in the data segment in the given object.
50
51
-EXAMPLE:
51
+Example:
52
+
53
$ echo "hello" | ipfs object patch $HASH append-data
54
55
note: this does not append data to a 'file', it modifies the actual raw
@@ -113,7 +114,7 @@ var patchSetDataCmd = &cmds.Command{
114
ShortDescription: `
115
Set the data of an ipfs object from stdin or with the contents of a file
116
116
-EXAMPLE:
117
+Example:
118
119
$ echo "my data" | ipfs object patch $MYHASH set-data
120
`,
@@ -235,11 +236,11 @@ var patchAddLinkCmd = &cmds.Command{
236
ShortDescription: `
237
Add a merkle-link to the given object and return the hash of the result.
238
238
-Examples:
239
+Example:
240
240
- EMPTY_DIR=$(ipfs object new unixfs-dir)
241
- BAR=$(echo "bar" | ipfs add -q)
242
- ipfs object patch $EMPTY_DIR add-link foo $BAR
241
+ $ EMPTY_DIR=$(ipfs object new unixfs-dir)
242
+ $ BAR=$(echo "bar" | ipfs add -q)
243
+ $ ipfs object patch $EMPTY_DIR add-link foo $BAR
244
245
This takes an empty directory, and adds a link named foo under it, pointing to
246
a file containing 'bar', and returns the hash of the new object.