eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-23 18:29:47 +01:00
Code Issues Releases Wiki Activity
home-manager/tests/modules/services/emacs/emacs-socket-27.nix

44 lines
1.4 KiB
Nix
Raw Normal View History

emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314
2020-06-08 23:01:17 +02:00
{ config, lib, pkgs, ... }:
with lib;
let
in {
config = {
nixpkgs.overlays = [
(self: super: rec {
services/emacs: Update systemd definitions, drop Emacs 26 support Emacs 27 added Type=notify support and updated the service definition to remove the use of `emacsclient' to kill the service. Emacs 28 changes the `StartupWMClass' in emacsclient.desktop to `Emacsd'. Update our emacs.service and emacsclient.desktop definitions to match upstream changes. When killing emacs.service, the socket is removed, and subsequently starting the service manually results in a service without a socket. Prevent this by adding `RefuseManualStart=true' to the service's Unit definition. Drop Emacs 26 support as it is no longer shipped in nixpkgs. Update the tests to verify the following configuration scenarios: - Emacs version: 27, 28 - Socket activation: disabled, enabled
2021-05-23 22:24:30 +02:00
emacs = pkgs.writeShellScriptBin "dummy-emacs-27.2" "" // {
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314
2020-06-08 23:01:17 +02:00
outPath = "@emacs@";
};
emacsPackagesFor = _:
makeScope super.newScope (_: { emacsWithPackages = _: emacs; });
})
];
programs.emacs.enable = true;
services.emacs.enable = true;
services.emacs.client.enable = true;
services.emacs: add option `extraOptions` This is to allow adding command-line arguments to the Emacs daemon. Previously only the Emacs client could be started with custom arguments.
2021-09-29 15:07:38 +02:00
services.emacs.extraOptions = [ "-f" "exwm-enable" ];
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314
2020-06-08 23:01:17 +02:00
services.emacs.socketActivation.enable = true;
nmt.script = ''
assertFileExists home-files/.config/systemd/user/emacs.socket
assertFileExists home-files/.config/systemd/user/emacs.service
assertFileExists home-path/share/applications/emacsclient.desktop
assertFileContent home-files/.config/systemd/user/emacs.socket \
services/emacs: Update systemd definitions, drop Emacs 26 support Emacs 27 added Type=notify support and updated the service definition to remove the use of `emacsclient' to kill the service. Emacs 28 changes the `StartupWMClass' in emacsclient.desktop to `Emacsd'. Update our emacs.service and emacsclient.desktop definitions to match upstream changes. When killing emacs.service, the socket is removed, and subsequently starting the service manually results in a service without a socket. Prevent this by adding `RefuseManualStart=true' to the service's Unit definition. Drop Emacs 26 support as it is no longer shipped in nixpkgs. Update the tests to verify the following configuration scenarios: - Emacs version: 27, 28 - Socket activation: disabled, enabled
2021-05-23 22:24:30 +02:00
${./emacs-socket-emacs.socket}
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314
2020-06-08 23:01:17 +02:00
assertFileContent home-files/.config/systemd/user/emacs.service \
emacs: fix service environment Emacs populates 'exec-path' at launch from the 'PATH' environment variable. Likewise, the emacs derivation from nixpkgs populates 'load-path' from the 'NIX_PROFILES' variable. As neither of these are available by default in the systemd user manager, revert to the previous behavior of launching the Emacs daemon from a login shell. Fixes #1354 Fixes #1340 PR #1355
2020-06-24 02:17:33 +02:00
${
pkgs.substituteAll {
services/emacs: Prevent deletion of socket file When running a socket-activated emacs service, we don't want emacs to remove the socket file after exiting, because then subsequent invocations of `emacsclient` won't be able to use the socket to start emacs.service again.
2021-05-30 04:40:58 +02:00
inherit (pkgs) runtimeShell coreutils;
services/emacs: Update systemd definitions, drop Emacs 26 support Emacs 27 added Type=notify support and updated the service definition to remove the use of `emacsclient' to kill the service. Emacs 28 changes the `StartupWMClass' in emacsclient.desktop to `Emacsd'. Update our emacs.service and emacsclient.desktop definitions to match upstream changes. When killing emacs.service, the socket is removed, and subsequently starting the service manually results in a service without a socket. Prevent this by adding `RefuseManualStart=true' to the service's Unit definition. Drop Emacs 26 support as it is no longer shipped in nixpkgs. Update the tests to verify the following configuration scenarios: - Emacs version: 27, 28 - Socket activation: disabled, enabled
2021-05-23 22:24:30 +02:00
src = ./emacs-socket-emacs.service;
emacs: fix service environment Emacs populates 'exec-path' at launch from the 'PATH' environment variable. Likewise, the emacs derivation from nixpkgs populates 'load-path' from the 'NIX_PROFILES' variable. As neither of these are available by default in the systemd user manager, revert to the previous behavior of launching the Emacs daemon from a login shell. Fixes #1354 Fixes #1340 PR #1355
2020-06-24 02:17:33 +02:00
}
}
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314
2020-06-08 23:01:17 +02:00
assertFileContent home-path/share/applications/emacsclient.desktop \
services/emacs: Update systemd definitions, drop Emacs 26 support Emacs 27 added Type=notify support and updated the service definition to remove the use of `emacsclient' to kill the service. Emacs 28 changes the `StartupWMClass' in emacsclient.desktop to `Emacsd'. Update our emacs.service and emacsclient.desktop definitions to match upstream changes. When killing emacs.service, the socket is removed, and subsequently starting the service manually results in a service without a socket. Prevent this by adding `RefuseManualStart=true' to the service's Unit definition. Drop Emacs 26 support as it is no longer shipped in nixpkgs. Update the tests to verify the following configuration scenarios: - Emacs version: 27, 28 - Socket activation: disabled, enabled
2021-05-23 22:24:30 +02:00
${./emacs-27-emacsclient.desktop}
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314
2020-06-08 23:01:17 +02:00
'';
};
}
Reference in a new issue Copy permalink