03/15: services: nginx: Improve reload action documentation.

[guix-commits]

cbaines pushed a commit to branch master
in repository guix.

commit dbdc8f64e7e2d35abbfbfc40ac06cf103207d99e
Author: EuAndreh via Guix-patches via <guix-patches@gnu.org>
AuthorDate: Mon Oct 17 18:28:11 2022 -0300

    services: nginx: Improve reload action documentation.
    
    * gnu/services/web.scm (nginx-shepherd-service): Be explicit about the
    reload action not changing the configuration file, but instead
    respawning worker processes.
    
    Signed-off-by: Christopher Baines <mail@cbaines.net>
---
 gnu/services/web.scm | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

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 @@ of index files."
               (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