Repository navigation
docs(cli): teach the .sock rule instead of the deprecated --port 0 Unix-socket spelling #1631
Description
Summary
The --host/--port help text (in both binaries) and docs/python-client.md still teach the deprecated --port 0 Unix-socket spelling. The current rule is the .sock suffix on --host, and the old form emits a deprecation warning at runtime.
Background
All four flag doc-comments read:
/// Host address to bind to (or Unix socket path when --port 0)
/// Port number to listen on (0 = Unix socket mode using --host as socket path)
src/main.rs:1172,1176src/bin/mlx_server.rs:403,407
Ground truth is in src/server/transport.rs: the selection rule is "--host ending in .sock is a Unix domain socket path, whatever --port says" (the b10621 rule, transport.rs:107), and the --port 0 form emits a deprecation warning (transport.rs:98,133-138). In docs, README.md:115 already uses the new spelling, but docs/python-client.md:61-62 still explains the old rule ("--port 0 reinterprets --host as the socket path") and :81 repeats it.
Proposed Solution
Rewrite the four doc-comments and the two python-client.md passages around the .sock rule, mentioning --port 0 only as a deprecated alias if at all.
Implementation Notes
- These are six one-line text edits with no logic change.
Acceptance Criteria
-
--helpfor both binaries describes the.sockrule as primary. -
docs/python-client.mdno longer teaches--port 0as the rule.
Original Suggestion
Title: docs(cli): --host/--port help text still teaches the deprecated --port 0 Unix-socket spelling
The --host/--port help text (in both binaries) and docs/python-client.md still teach the deprecated --port 0 Unix-socket spelling. The current rule is the .sock suffix on --host, and the old form emits a deprecation warning at runtime.
Evidence
All four flag doc-comments read:
/// Host address to bind to (or Unix socket path when --port 0)
/// Port number to listen on (0 = Unix socket mode using --host as socket path)
src/main.rs:1172,1176src/bin/mlx_server.rs:403,407
Ground truth: src/server/transport.rs:103-140 — rule 1 is "--host ending in .sock is a Unix domain socket path, whatever --port says. This is the b10621 rule and the spelling to use", and the --port 0 form emits a deprecation warning (transport.rs:133-138).
Docs: README.md:115 already uses the new spelling, but docs/python-client.md:61-62 still explains the old rule ("--port 0 reinterprets --host as the socket path") and :81 repeats it.
Suggested fix
Rewrite the four doc-comments and the two python-client.md passages around the .sock rule, mentioning --port 0 only as a deprecated alias if at all. Six one-line text edits.
Acceptance criteria
-
--helpfor both binaries describes the.sockrule as primary -
docs/python-client.mdno longer teaches--port 0as the rule
Activity
[-]docs(cli): --host/--port help text still teaches the deprecated --port 0 Unix-socket spelling[/-][+]docs(cli): teach the .sock rule instead of the deprecated --port 0 Unix-socket spelling[/+]docs(cli): document the .sock listener rule (#1647)
perf(cuda): convert bf16 weights to f16 at load on pre-Ampere GPUs (#…
docs(cli): document the .sock listener rule (lablup#1647)
perf(cuda/quant): add a Volta tensor-core arm to qmm_naive (#1678)