Skip to content

Commit 4c516df

Browse files
committed
[Docs] Add a note about the unix socket support
1 parent 8edbf81 commit 4c516df

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/modules/ROOT/pages/basics/up_and_running.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,10 @@ will handle this use-case transparently for you.
271271

272272
== Connecting via unix domain file socket
273273

274+
NOTE: Unix socket support was introduced in nREPL 0.9. Currently
275+
CIDER's support for Unix sockets is considered experimental and its
276+
interface might change in future CIDER releases.
277+
274278
When locally running nREPL servers, there is the option to listen on a
275279
socket file instead of opening a network port. This can have
276280
advantages in some use cases, e.g. when working with virtual networks
@@ -287,7 +291,7 @@ $ clj -R:nREPL -m nrepl.cmdline --socket nrepl.sock
287291
----
288292

289293
you can then connect CIDER by using the `local-unix-domain-socket`
290-
special hostname with `cider-connect`: kbd:[M-x] `cider-connect` kbd:[RET] `local-unix-domain-socket` kbd:[RET] `nrepl.sock` kbd:[RET]
294+
special hostname with `cider-connect`: kbd:[M-x] `cider-connect` kbd:[RET] `local-unix-domain-socket` kbd:[RET] `nrepl.sock` kbd:[RET].
291295

292296
== What's Next?
293297

0 commit comments

Comments
 (0)