From 4771f14af23c2a9c5dae9b3d57267bf981487a46 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 19 Oct 2021 09:33:43 +0000 Subject: [PATCH] doc: lei: describe lei-daemon-kill and upgrades While we're at it, start dropping copyright years since it seems acceptable to not have them: https://www.linuxfoundation.org/blog/copyright-notices-in-open-source-software-projects/ Copyright years are also a noisy to update every year (maybe, just maybe, we'll make it to 2022...) --- Documentation/lei-daemon-kill.pod | 29 ++++++++++++++++++++++++++--- Documentation/lei-overview.pod | 8 +++++++- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/Documentation/lei-daemon-kill.pod b/Documentation/lei-daemon-kill.pod index 7fb0fb25..48c237b8 100644 --- a/Documentation/lei-daemon-kill.pod +++ b/Documentation/lei-daemon-kill.pod @@ -8,7 +8,30 @@ lei daemon-kill [-SIGNAL | -s SIGNAL | --signal SIGNAL] =head1 DESCRIPTION -Send a signal to the lei-daemon. C defaults to C. +Send a signal to the L. C defaults to C. + +This command should be run after updating the code of lei. + +=head1 SIGNALS + +=over 8 + +=item SIGTERM + +Send a graceful termination signal. L will exit +when all currently running lei commands are done. The listen +socket will be released as soon as the signal is processed +so another L process can take its place. + +=item SIGKILL + +Kills L immediately. Some worker processes may +remain running after a short while after this takes effect. + +=back + +=for comment +SIGQUIT and SIGINT currently do what SIGTERM do, may change... =head1 CONTACT @@ -19,10 +42,10 @@ L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L =head1 SEE ALSO -L +L, L diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod index 40a7b0aa..bb2fe50f 100644 --- a/Documentation/lei-overview.pod +++ b/Documentation/lei-overview.pod @@ -131,6 +131,12 @@ C. Contributions adding support for other shells, as well as improvements to the existing Bash completion, are welcome. +=head1 UPGRADING + +Since lei runs as a daemon, L is required to kill +the daemon so it can load new code. It will be restarted with the +next invocation of any lei command. + =head1 CONTACT Feedback welcome via plain-text mail to L @@ -140,6 +146,6 @@ L =head1 COPYRIGHT -Copyright 2021 all contributors L +Copyright all contributors L License: AGPL-3.0+ L -- 2.51.0