chore: mark fuse experimental (#8962)
It works only on some platforms, and does not work reliably. This corrects our error of not setting expectations right.
Marcin Rataj committed
May 12, 2022 at 19:32 UTC
53299e84e0995124c97fdb76571f8646cf03c6a7
7 files changed
+18
-2
cmd/ipfs/daemon.go
+1
-1
@@ -169,7 +169,7 @@ Headers.
169
cmds.StringOption(initConfigOptionKwd, "Path to existing configuration file to be loaded during --init"),
170
cmds.StringOption(initProfileOptionKwd, "Configuration profiles to apply for --init. See ipfs init --help for more"),
171
cmds.StringOption(routingOptionKwd, "Overrides the routing option").WithDefault(routingOptionDefaultKwd),
172
- cmds.BoolOption(mountKwd, "Mounts IPFS to the filesystem"),
172
+ cmds.BoolOption(mountKwd, "Mounts IPFS to the filesystem using FUSE (experimental)"),
173
cmds.BoolOption(writableKwd, "Enable writing objects (with POST, PUT and DELETE)"),
174
cmds.StringOption(ipfsMountKwd, "Path to the mountpoint for IPFS (if using --mount). Defaults to config setting."),
175
cmds.StringOption(ipnsMountKwd, "Path to the mountpoint for IPNS (if using --mount). Defaults to config setting."),
core/commands/mount_nofuse.go
+1
@@ -8,6 +8,7 @@ import (
8
)
9
10
var MountCmd = &cmds.Command{
11
+ Status: cmds.Experimental,
12
Helptext: cmds.HelpText{
13
Tagline: "Mounts ipfs to the filesystem (disabled).",
14
ShortDescription: `
core/commands/mount_unix.go
+1
@@ -21,6 +21,7 @@ const (
21
)
22
23
var MountCmd = &cmds.Command{
24
+ Status: cmds.Experimental,
25
Helptext: cmds.HelpText{
26
Tagline: "Mounts IPFS to the filesystem (read-only).",
27
ShortDescription: `
core/commands/root.go
+1
-1
@@ -52,7 +52,6 @@ TEXT ENCODING COMMANDS
52
53
ADVANCED COMMANDS
54
daemon Start a long-running daemon process
55
- mount Mount an IPFS read-only mount point
55
resolve Resolve any type of content path
56
name Publish and resolve IPNS names
57
key Create and list IPNS name keypairs
@@ -61,6 +60,7 @@ ADVANCED COMMANDS
60
stats Various operational stats
61
p2p Libp2p stream mounting (experimental)
62
filestore Manage the filestore (experimental)
63
+ mount Mount an IPFS read-only mount point (experimental)
64
65
NETWORK COMMANDS
66
id Show info about IPFS peers
docs/config.md
+2
@@ -1035,6 +1035,8 @@ Default: `cache`
1035
1036
## `Mounts`
1037
1038
+**EXPERIMENTAL:** read about current limitations at [fuse.md](./fuse.md).
1039
+
1040
FUSE mount point configuration options.
1041
1042
### `Mounts.IPFS`
docs/experimental-features.md
+10
@@ -19,6 +19,7 @@ the above issue.
19
- [Private Networks](#private-networks)
20
- [ipfs p2p](#ipfs-p2p)
21
- [p2p http proxy](#p2p-http-proxy)
22
+- [FUSE](#fuse)
23
- [Plugins](#plugins)
24
- [Directory Sharding / HAMT](#directory-sharding--hamt)
25
- [IPNS PubSub](#ipns-pubsub)
@@ -386,6 +387,15 @@ We also support the use of protocol names of the form /x/$NAME/http where $NAME
387
- [ ] More documentation
388
- [ ] Need better integration with the subdomain gateway feature.
389
390
+## FUSE
391
+
392
+FUSE makes it possible to mount `/ipfs` and `/ipns` namespaces in your OS,
393
+allowing argitrary apps access to IPFS using a subset of filesystem abstracitons.
394
+
395
+It is considered EXPERIMENTAL due to limited (and buggy) support on some platforms.
396
+
397
+See [fuse.md](./fuse.md) for more details.
398
+
399
## Plugins
400
401
### In Version
docs/fuse.md
+2
@@ -1,5 +1,7 @@
1
# FUSE
2
3
+**EXPERIMENTAL:** FUSE support is limited, YMMV.
4
+
5
`go-ipfs` makes it possible to mount `/ipfs` and `/ipns` namespaces in your OS,
6
allowing arbitrary apps access to IPFS.
7