doc: server.listen truncates socket path on unix

[jeanregisser]

Checklist

• documentation is changed or added
• the commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

I found out that calling the following code would create a UNIX socket with a truncated path:

const net = require('net');
var server = net.createServer();
server.listen('/tmp/0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz');
// On the FS it ends up creating '/tmp/0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnop' 
// i.e. 103 chars on OSX instead of the initial 113 chars

Internally it ends up calling uv_pipe_bind with the given path which itself is documented to truncate the path. See http://docs.libuv.org/en/v1.x/pipe.html#c.uv_pipe_bind

This is NOT a bug, but a restriction of the unix socket api, as it stores the path in sockaddr_un.sun_path (104 chars on OSX, 108 chars on Linux), see man unix.

[bnoordhuis]

The convention in the documentation seems to be to spell it as 'OS X' (space before the X.)

EDIT: In the commit log as well.

[bnoordhuis]

LGTM with nit.

/cc @nodejs/documentation

[jasnell]

LGTM

[estliberitas]

LGTM

[addaleax]

LGTM

[addaleax]

Landed in 4c24fbf, removed trailing whitespace upon landing. Thanks!

[MylesBorins]

@addaleax lts?

[addaleax]

@thealphanerd yep 👍