From 578b48aed953218f16246670bbc164f7c331fc67 Mon Sep 17 00:00:00 2001 From: evansmj Date: Thu, 9 Nov 2023 11:40:38 -0500 Subject: [PATCH] Sync bind-addr docs In the original [$6173] pr `bind` was a typo for `bind-addr`. `bind` never existed, so this commit updates uses of `bind` to `bind-addr`. This links lightningd-config.5.md to configuration.md since `bind-addr` has options of interest such as ipv4/ipv6. --- CHANGELOG.md | 4 ++-- doc/lightningd-config.5.md | 3 ++- lightningd/options.c | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 022175bb5bf6..8e790dffcdd6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -66,7 +66,7 @@ This release named by Matt Morehouse. - JSON-RPC: `listconfigs` now has `configs` subobject with more information about each config option. ([#6243]) - Config: `--regtest` option as alias for `--network=regtest` ([#6243]) - Config: `accept-htlc-tlv-type` (replaces awkward-to-use `accept-htlc-tlv-types`) ([#6243]) - - Config: `bind=ws:...` to explicitly listen on a websocket. ([#6173]) + - Config: `bind-addr=ws:...` to explicitly listen on a websocket. ([#6173]) - Config: `bind` can now take `dns:` prefix to advertize DNS records. ([#6173]) - Plugins: `sendpay` now allows self-payment of invoices, by specifying an empty route. ([#6399]) - Plugins: plugins can subscribe to all notifications using "*". ([#6347]) @@ -108,7 +108,7 @@ Note: You should always set `allow-deprecated-apis=false` to test for changes. - JSON-RPC: `listconfigs` direct fields, use `configs` sub-object and `set`, `value_bool`, `value_str`, `value_int`, or `value_msat` fields. ([#6243]) - Config: boolean plugin options set to `1` or `0` (use `true` and `false` like non-plugin options). ([#6243]) - Config: `accept-htlc-tlv-types` (use `accept-htlc-tlv-type` multiple times) ([#6243]) - - Config: `experimental-websocket-port`: use `--bind=ws::`. ([#6173]) + - Config: `experimental-websocket-port`: use `--bind-addr=ws::`. ([#6173]) - Config: bind-addr=xxx.onion and addr=xxx.onion, use announce-addr=xxx.onion (which was always equivalent). ([#6173]) - Config: addr=/socketpath, use listen=/socketpath (which was always equivalent). ([#6173]) - Config: `announce-addr-dns`; use `--bind-addr=dns:ADDR` for finer control. ([#6173]) diff --git a/doc/lightningd-config.5.md b/doc/lightningd-config.5.md index 192164f9b423..695acf900077 100644 --- a/doc/lightningd-config.5.md +++ b/doc/lightningd-config.5.md @@ -761,7 +761,8 @@ connections on that port, on any IPv4 and IPv6 addresses you listen to ([bolt][bolt] #891). The normal protocol is expected to be sent over WebSocket binary frames once the connection is upgraded. - You should use `bind=ws::` instead to create a WebSocket listening port. + You should use `bind-addr=ws::` instead to create a WebSocket listening port. + see [Networking options](getting-started/getting-started/configuration.md#networking-options) * **experimental-peer-storage** diff --git a/lightningd/options.c b/lightningd/options.c index e28482ce9623..bd6c2af8286e 100644 --- a/lightningd/options.c +++ b/lightningd/options.c @@ -1162,7 +1162,7 @@ static char *opt_set_websocket_port(const char *arg, struct lightningd *ld) char *err; if (!ld->deprecated_apis) - return "--experimental-websocket-port been deprecated, use --bind=ws:..."; + return "--experimental-websocket-port been deprecated, use --bind-addr=ws:..."; err = opt_set_u32(arg, &port); if (err)