[PATCH v2 5/6] maintenance: update systemd scheduler docs
- From
Max Gautier <mg@max.gautier.name>
- Date
- Mar 22, 2024, 22:11 UTC
- Message-ID
- <20240322221327.12204-6-mg@max.gautier.name>
- In-Reply-To
- <20240322221327.12204-1-mg@max.gautier.name>
The `git maintenance` systemd scheduler no longer writes units in $XDG_CONFIG_HOME.
Describe the new behavior. Instead of explaining manual ways to modify the timer, suggest the systemd standard tool: `systemctl edit`.
Signed-off-by: Max Gautier <mg@max.gautier.name> --- Documentation/git-maintenance.txt | 33 +++++++++++++++---------------- 1 file changed, 16 insertions(+), 17 deletions(-)
diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt index 51d0f7e94b..6511c3f3f1 100644 --- a/Documentation/git-maintenance.txt +++ b/Documentation/git-maintenance.txt @@ -304,10 +304,9 @@ distributions, systemd timers are superseding it. If user systemd timers are available, they will be used as a replacement of `cron`. -In this case, `git maintenance start` will create user systemd timer units -and start the timers. The current list of user-scheduled tasks can be found -by running `systemctl --user list-timers`. The timers written by `git -maintenance start` are similar to this: +In this case, `git maintenance start` will enable user systemd timer units +and start them. The current list of user-scheduled tasks can be found by +running `systemctl --user list-timers`. These timers are similar to this: ----------------------------------------------------------------------- $ systemctl --user list-timers @@ -317,25 +316,25 @@ Fri 2021-04-30 00:00:00 CEST 5h 42min left Thu 2021-04-29 00:00:11 CEST 18h ago Mon 2021-05-03 00:00:00 CEST 3 days left Mon 2021-04-26 00:00:11 CEST 3 days ago git-maintenance@weekly.timer git-maintenance@weekly.service ----------------------------------------------------------------------- -One timer is registered for each `--schedule=<frequency>` option. +One timer instance is enabled for each `--schedule=<frequency>` option. -The definition of the systemd units can be inspected in the following files: +The definition of the systemd units can be inspected this way: ----------------------------------------------------------------------- -~/.config/systemd/user/git-maintenance@.timer -~/.config/systemd/user/git-maintenance@.service -~/.config/systemd/user/timers.target.wants/git-maintenance@hourly.timer -~/.config/systemd/user/timers.target.wants/git-maintenance@daily.timer -~/.config/systemd/user/timers.target.wants/git-maintenance@weekly.timer +$ systemctl cat --user git-maintenance@.timer +$ systemctl cat --user git-maintenance@.service ----------------------------------------------------------------------- -`git maintenance start` will overwrite these files and start the timer -again with `systemctl --user`, so any customization should be done by -creating a drop-in file, i.e. a `.conf` suffixed file in the -`~/.config/systemd/user/git-maintenance@.service.d` directory. +Customization of the timer or service can be performed with the usual systemd +tooling: +----------------------------------------------------------------------- +$ systemctl edit --user git-maintenance@.timer # all the timers +$ systemctl edit --user git-maintenance@hourly.timer # the hourly timer +$ systemctl edit --user git-maintenance@.service # all the services +$ systemctl edit --user git-maintenance@hourly.service # the hourly run +----------------------------------------------------------------------- -`git maintenance stop` will stop the user systemd timers and delete -the above mentioned files. +`git maintenance stop` will disable and stop the user systemd timers. For more details, see `systemd.timer(5)`.
-- 2.44.0