From eb9f8cfa1fed5770680c24f3029624636bf8f8cf Mon Sep 17 00:00:00 2001 From: "Leo R. Lundgren" Date: Wed, 24 Jul 2024 20:59:04 +0200 Subject: [PATCH] doc: Polish unreleased changelogs --- changelog/unreleased/pull-271 | 11 +++++------ changelog/unreleased/pull-272 | 7 +++++-- changelog/unreleased/pull-273 | 8 +++++--- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/changelog/unreleased/pull-271 b/changelog/unreleased/pull-271 index f785549..3c5de2d 100644 --- a/changelog/unreleased/pull-271 +++ b/changelog/unreleased/pull-271 @@ -1,10 +1,9 @@ -Enhancement: print actual listen address after start-up +Enhancement: Print listening address after start-up -When started with `--listen :0` the server would print `start server on :0` +When started with `--listen :0`, rest-server would print `start server on :0` -Now the message includes the actual address listened on, for example -`start server on 0.0.0.0:37333`. - -This is useful when starting a server with an auto-allocated free port number (port 0). +The message now also includes the actual address listened on, for example +`start server on 0.0.0.0:37333`. This is useful when starting a server with +an auto-allocated free port number (port 0). https://github.com/restic/rest-server/pull/271 diff --git a/changelog/unreleased/pull-272 b/changelog/unreleased/pull-272 index 0d8cccc..34bab18 100644 --- a/changelog/unreleased/pull-272 +++ b/changelog/unreleased/pull-272 @@ -1,8 +1,11 @@ Enhancement: Support listening on a unix socket -To let rest-server listen on a unix socket, prefix the socket filename with `unix:` and pass it to the `--listen` option, for example `--listen unix:/tmp/foo`. +It is now possible to make rest-server listen on a unix socket by prefixing +the socket filename with `unix:` and passing it to the `--listen` option, +for example `--listen unix:/tmp/foo`. -This is useful in combination with remote port forwarding to enable remote server to backup locally, e.g. +This is useful in combination with remote port forwarding to enable a remote +server to backup locally, e.g.: ``` rest-server --listen unix:/tmp/foo & diff --git a/changelog/unreleased/pull-273 b/changelog/unreleased/pull-273 index c8cb44f..98679c9 100644 --- a/changelog/unreleased/pull-273 +++ b/changelog/unreleased/pull-273 @@ -1,7 +1,9 @@ -Change: Server is now shutdown cleanly on TERM or INT signals +Change: Shut down cleanly on TERM and INT signals -Server now listens for TERM and INT signals and cleanly closes down the http.Server and listener. +Rest-server now listens for TERM and INT signals and cleanly closes down the +http.Server and listener when receiving either of them. -This is particularly useful when listening on a unix socket, as the server will remove the socket file from it shuts down. +This is particularly useful when listening on a unix socket, as the server +will now remove the socket file when it shuts down. https://github.com/restic/rest-server/pull/273