Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning for configuration file copy in flake systems #357824

Open
wants to merge 2 commits into
base: nixos-24.05
Choose a base branch
from

Conversation

mrtuxa
Copy link

@mrtuxa mrtuxa commented Nov 21, 2024

This update adds a warning to the documentation regarding the use of the configuration file copy feature. It clarifies that this feature cannot be used when the system is configured as a flake.

This change aims to prevent confusion.

Changes

Added a warning in the documentation that the configuration file copy feature cannot be used with flake-based systems.

Motivation:

The intention of this change is to prevent confusion among users who may attempt to use the configuration file copy feature while operating within a flake-based environment. By providing clear guidance, we aim to enhance the user experience and ensure that users are aware of the limitations associated with flakes.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

This update adds a warning to the documentation regarding the use of the 
configuration file copy feature. It clarifies that this feature cannot 
be used when the system is configured as a flake. Users are directed 

This change aims to prevent confusion,
@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant