Skip to content

Commit c4b7595

Browse files
lideljohnnymatthews
andcommitted
docs: apply suggestions from code review
Co-authored-by: Johnny <[email protected]>
1 parent 8ffc775 commit c4b7595

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/config.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,32 +188,31 @@ documented in `ipfs config profile --help`.
188188

189189
- `flatfs`
190190

191-
Configures the node to use the flatfs datastore (the default).
191+
Configures the node to use the flatfs datastore. Flatfs is the default datastore.
192192

193193
This is the most battle-tested and reliable datastore.
194194
You should use this datastore if:
195195

196-
- You need a very simple and very reliable datastore and you trust your
196+
- You need a very simple and very reliable datastore, and you trust your
197197
filesystem. This datastore stores each block as a separate file in the
198198
underlying filesystem so it's unlikely to lose data unless there's an issue
199199
with the underlying file system.
200200
- You need to run garbage collection in a way that reclaims free space as soon as possible.
201201
- You want to minimize memory usage.
202-
- You are ok with the default speed of data import (or prefer to use `--nocopy`).
202+
- You are ok with the default speed of data import, or prefer to use `--nocopy`.
203203

204204
This profile may only be applied when first initializing the node.
205205

206206

207207
- `badgerds`
208208

209-
Configures the node to use the experimental badger datastore (warning: uses an outdated badger 1.x).
209+
Configures the node to use the experimental badger datastore. Keep in mind that this **uses an outdated badger 1.x**.
210210

211211
Use this datastore if some aspects of performance,
212212
especially the speed of adding many gigabytes of files, are critical. However, be aware that:
213213

214214
- This datastore will not properly reclaim space when your datastore is
215-
smaller than several gigabytes. If you run IPFS with `--enable-gc` (you have
216-
enabled block-level garbage collection), you plan on storing very little data in
215+
smaller than several gigabytes. If you run IPFS with `--enable-gc`, you plan on storing very little data in
217216
your IPFS node, and disk usage is more critical than performance, consider using
218217
`flatfs`.
219218
- This datastore uses up to several gigabytes of memory.

0 commit comments

Comments
 (0)