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

apptainer, singularity: format Nix expression according to Nix RFC 166 #306656

Merged
merged 5 commits into from
Apr 25, 2024

Conversation

ShamrockLee
Copy link
Contributor

@ShamrockLee ShamrockLee commented Apr 25, 2024

Description of changes

Format pkgs/applications/virtualization/singularity/{generic.nix,packages.nix} and nixos/modules/programs/singularity.nix with nixfmt to make them conform Nix RFC 166, providing a clean ground for subsequent changes.

Prevent unwanted absorption by comments. See also NixOS/nixfmt#198.

Cc: @GaetanLepage @jbedo @SomeoneSerge

Things done

  • Built on platform(s)
    • x86_64-linux (evaluation result should stay the same)
    • 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/)
  • 24.05 Release Notes (or backporting 23.05 and 23.11 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.

@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 Apr 25, 2024
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Apr 25, 2024
@ShamrockLee
Copy link
Contributor Author

Bump onto the master branch and resolve merge conflict.

Add comment above "defaultToSuid = true" to explain it
and to keep it multi-line after formatting.
Make the Nix expression generic.nix and package.nix conformant to Nix
RFC 166.
Copy link
Contributor

@SomeoneSerge SomeoneSerge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I understand correctly:

  • The new revision doesn't include any manual edits, it's a fully automated reformatting.
  • The custom nixfmt patches will eventually make their way into nixpkgs' nixfmt-rfc-style package?

@ShamrockLee
Copy link
Contributor Author

ShamrockLee commented Apr 25, 2024

The new revision doesn't include any manual edits, it's a fully automated reformatting.

Yes.

The custom nixfmt patches will eventually make their way into nixpkgs' nixfmt-rfc-style package?

I manipulate the formatting result by adding comments to the Nix code. The formatter is fetched unmodified from the master branch of NixOS/nixfmt.

For example,

{
  foo = [
    "aaaa"
    "bbbb"
  ]
  ++ lib.optional true "cccc"
  ++ lib.optional true "dddd";
}

formats to

{
  foo = [
    "aaaa"
    "bbbb"
  ] ++ lib.optional true "cccc"  ++ lib.optional true "dddd";
}

while

{
  foo = [
    "aaaa"
    "bbbb"
  ]
  # Optional dependencies
  ++ lib.optional true "cccc"
  ++ lib.optional true "dddd";
}

formats to

{
  foo =
    [
      "aaaa"
      "bbbb"
    ]
    # Optional dependencies
    ++ lib.optional true "cccc" 
    ++ lib.optional true "dddd";
}

Copy link
Contributor

@GaetanLepage GaetanLepage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool ! LGTM

@wegank wegank added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Apr 25, 2024
@SomeoneSerge SomeoneSerge merged commit 5e05a5e into NixOS:master Apr 25, 2024
28 checks passed
@ShamrockLee ShamrockLee deleted the apptainer-format branch April 26, 2024 06:01
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/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 12.approvals: 1 This PR was reviewed and approved by one reputable person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants