diff mbox series

[bug#58590] services: nginx: Improve reload action documentation.

Message ID 20221017215500.11024-1-eu@euandre.org
State Accepted
Headers show
Series [bug#58590] services: nginx: Improve reload action documentation. | expand

Checks

Context Check Description
cbaines/applying patch fail View Laminar job
cbaines/issue success View issue

Commit Message

EuAndreh Oct. 17, 2022, 9:55 p.m. UTC 
* gnu/services/web.scm (nginx-shepherd-service): Be explicit about the
reload action not changing the configuration file, but instead
respawning worker processes.
---
 gnu/services/web.scm | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/gnu/services/web.scm b/gnu/services/web.scm
index 7fde8824b3..2023119037 100644
--- a/gnu/services/web.scm
+++ b/gnu/services/web.scm
@@ -819,7 +819,11 @@  (define (nginx-shepherd-service config)
               (list
                (shepherd-action
                  (name 'reload)
-                 (documentation "Reload NGINX configuration file and restart worker processes.")
+                 (documentation "Reload nginx configuration file and restart worker processes.
+This has the effect of killing old worker processes and starting new ones, using
+the same configuration file.  It is useful for situations where the same nginx
+configuration file can point to different things after a reload, such as
+renewed TLS certificates, or @code{include}d files.")
                  (procedure (nginx-action "-s" "reload"))))))))))
 
 (define nginx-service-type