You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/add-code-flow.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,7 @@ Within the function, a new `Adder` is created with the configured `Blockstore` a
55
55
56
56
1. **[`adder.add(io.Reader)`](https://github.com/ipfs/go-ipfs/blob/v0.4.18/core/coreunix/add.go#L115)** - *Create and return the **root** __DAG__ node*
57
57
58
-
This method converts the input data (`io.Reader`) to a __DAG__ tree, by splitting the data into _chunks_ using the `Chunker` and organizing them in to a __DAG__ (with a *trickle* or *balanced* layout. See [balanced](https://github.com/ipfs/go-unixfs/blob/6b769632e7eb8fe8f302e3f96bf5569232e7a3ee/importer/balanced/builder.go) for more info).
58
+
This method converts the input data (`io.Reader`) to a __DAG__ tree, by splitting the data into _chunks_ using the `Chunker` and organizing them into a __DAG__ (with a *trickle* or *balanced* layout. See [balanced](https://github.com/ipfs/go-unixfs/blob/6b769632e7eb8fe8f302e3f96bf5569232e7a3ee/importer/balanced/builder.go) for more info).
59
59
60
60
The method returns the **root** `ipld.Node` of the __DAG__.
61
61
@@ -70,7 +70,7 @@ Within the function, a new `Adder` is created with the configured `Blockstore` a
70
70
71
71
- **[MFS] [`PutNode(mfs.Root, path, ipld.Node)`](https://github.com/ipfs/go-mfs/blob/v0.1.18/ops.go#L86)** - *Insert node at path into given `MFS`*
72
72
73
-
The `path` param is used to determine the `MFS Directory`, which is first looked up in the `MFS` using `lookupDir()` function. This is followed by adding the **root** __DAG__ node (`ipld.Node`) in to this `Directory` using `directory.AddChild()` method.
73
+
The `path` param is used to determine the `MFS Directory`, which is first looked up in the `MFS` using `lookupDir()` function. This is followed by adding the **root** __DAG__ node (`ipld.Node`) into this `Directory` using `directory.AddChild()` method.
74
74
75
75
- **[MFS] Add Child To `UnixFS`**
76
76
- **[`directory.AddChild(filename, ipld.Node)`](https://github.com/ipfs/go-mfs/blob/v0.1.18/dir.go#L350)** - *Add **root** __DAG__ node under this directory*
Copy file name to clipboardExpand all lines: docs/datastores.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ field in the ipfs configuration file.
12
12
13
13
## flatfs
14
14
15
-
Stores each keyvalue pair as a file on the filesystem.
15
+
Stores each key-value pair as a file on the filesystem.
16
16
17
17
The shardFunc is prefixed with `/repo/flatfs/shard/v1` then followed by a descriptor of the sharding strategy. Some example values are:
18
18
-`/repo/flatfs/shard/v1/next-to-last/2`
19
19
- Shards on the two next to last characters of the key
20
20
-`/repo/flatfs/shard/v1/prefix/2`
21
-
- Shards based on the twocharacter prefix of the key
21
+
- Shards based on the two-character prefix of the key
22
22
23
23
```json
24
24
{
@@ -34,7 +34,7 @@ The shardFunc is prefixed with `/repo/flatfs/shard/v1` then followed by a descri
34
34
NOTE: flatfs must only be used as a block store (mounted at `/blocks`) as it only partially implements the datastore interface. You can mount flatfs for /blocks only using the mount datastore (described below).
35
35
36
36
## levelds
37
-
Uses a leveldb database to store keyvalue pairs.
37
+
Uses a leveldb database to store key-value pairs.
38
38
39
39
```json
40
40
{
@@ -46,7 +46,7 @@ Uses a leveldb database to store key value pairs.
46
46
47
47
## pebbleds
48
48
49
-
Uses [pebble](https://github.com/cockroachdb/pebble) as a keyvalue store.
49
+
Uses [pebble](https://github.com/cockroachdb/pebble) as a key-value store.
50
50
51
51
```json
52
52
{
@@ -90,7 +90,7 @@ When installing a new version of kubo when `"formatMajorVersion"` is configured,
90
90
91
91
## badgerds
92
92
93
-
Uses [badger](https://github.com/dgraph-io/badger) as a keyvalue store.
93
+
Uses [badger](https://github.com/dgraph-io/badger) as a key-value store.
94
94
95
95
> [!CAUTION]
96
96
> This is based on very old badger 1.x, which has known bugs and is no longer supported by the upstream team.
@@ -99,7 +99,7 @@ Uses [badger](https://github.com/dgraph-io/badger) as a key value store.
99
99
100
100
101
101
*`syncWrites`: Flush every write to disk before continuing. Setting this to false is safe as kubo will automatically flush writes to disk before and after performing critical operations like pinning. However, you can set this to true to be extra-safe (at the cost of a 2-3x slowdown when adding files).
102
-
*`truncate`: Truncate the DB if a partially written sector is found (defaults to true). There is no good reason to set this to false unless you want to manually recover partially written (and unpinned) blocks if kubo crashes half-way through adding a file.
102
+
*`truncate`: Truncate the DB if a partially written sector is found (defaults to true). There is no good reason to set this to false unless you want to manually recover partially written (and unpinned) blocks if kubo crashes half-way through a write operation.
Copy file name to clipboardExpand all lines: docs/releases.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,9 @@
20
20
21
21
## Release Philosophy
22
22
23
-
`kubo` aims to have release every six weeks, two releases per quarter. During these 6 week releases, we go through 4 different stages that gives us the opportunity to test the new version against our test environments (unit, interop, integration), QA in our current production environment, IPFS apps (e.g. Desktop and WebUI) and with our community and _early testers_<sup>[1]</sup> that have IPFS running in production.
23
+
`kubo` aims to have a release every six weeks, two releases per quarter. During these 6 week releases, we go through 4 different stages that allow us to test the new version against our test environments (unit, interop, integration), QA in our current production environment, IPFS apps (e.g. Desktop and WebUI) and with our community and _early testers_<sup>[1]</sup> that have IPFS running in production.
24
24
25
-
We might expand the sixweek release schedule in case of:
25
+
We might expand the six-week release schedule in case of:
26
26
27
27
- No new updates to be added
28
28
- In case of a large community event that takes the core team availability away (e.g. IPFS Conf, Dev Meetings, IPFS Camp, etc.)
@@ -59,7 +59,7 @@ Test the release in as many non-production environments as possible. This is rel
59
59
60
60
### Stage 3 - Community Prod Testing
61
61
62
-
At this stage, we consider the release to be "productionready" and will ask the community and our early testers to (partially) deploy the release to their production infrastructure.
62
+
At this stage, we consider the release to be "production-ready" and will ask the community and our early testers to (partially) deploy the release to their production infrastructure.
63
63
64
64
**Goals:**
65
65
@@ -69,7 +69,7 @@ At this stage, we consider the release to be "production ready" and will ask the
69
69
70
70
### Stage 4 - Release
71
71
72
-
At this stage, the release is "battlehardened" and ready for wide deployment.
72
+
At this stage, the release is "battle-hardened" and ready for wide deployment.
0 commit comments