sway: print hint when checking the config file fails #7665
+6
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
home-manager-ci
bot
requested review from
Scrumplex,
sumnerevans,
alexarice and
oxalica
Scrumplex
reviewed
Aug 14, 2025
| ${pkgs.xvfb-run}/bin/xvfb-run ${cfg.package}/bin/sway --config "$target" --validate --unsupported-gpu || { | ||
| echo "Checking the sway config file failed. Normally, this happens because there are errors in the config file." | ||
| echo "But the check can also fail if the sway config file has dependencies on configuration that is not available in the Nix build sandbox (e.g. custom keyboard layouts defined in the NixOS configuration; background images in the user's home directory)." | ||
| echo "In that case, it may be necessary to set 'config.wayland.windowManager.sway.checkConfig = false;'." |
There was a problem hiding this comment.
Suggested change
| echo "In that case, it may be necessary to set 'config.wayland.windowManager.sway.checkConfig = false;'." | |
| echo "In that case, it may be necessary to set 'wayland.windowManager.sway.checkConfig = false;'." |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is meant to address #5311.
I've felt compelled to do something about this after reading a comment by a user who said they've nearly given up transitioning from Arch to NixOS + home-manager because of it.
While it does not fix the issue of the check failing because of run-time dependencies not being available in the
checkPhase; it should make it easier for users to understand what is going on and how to work around it.Checklist
Change is backwards compatible.
Code formatted with
nix fmtornix-shell -p treefmt nixfmt deadnix keep-sorted --run treefmt.Code tested through
nix run .#tests -- test-allornix-shell --pure tests -A run.all. some unrelated anki test is currently failing?Test cases updated/added. See
example. I don't think this needs a test
Commit messages are formatted like
See CONTRIBUTING for more information and
recent commit messages for examples.
If this PR adds a new module
example.
News
Tests
If this PR adds an exciting new feature or contains a breaking change.
News