Revert "treewide: drop usage of nixfmt-rfc-style alias"

[jfly]

This reverts commit c19b2c3.

As per the discussion
here, it's too early to drop usage of the alias in documentation.

Removing the references is tracked by
#425583, which a member of the Nix Formatting team will do when the time is right.

Things done

• Built on platform:
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• Tested, as applicable:
  • NixOS tests in nixos/tests.
  • Package tests at passthru.tests.
  • Tests in lib/tests or pkgs/test for functions and "core" functionality.
• Ran nixpkgs-review on this PR. See nixpkgs-review usage.
• Tested basic functionality of all binary files, usually in ./result/bin/.
• Nixpkgs Release Notes
  • Package update: when the change is major or breaking.
• NixOS Release Notes
  • Module addition: when adding a new NixOS module.
  • Module update: when the change is significant.
• Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other READMEs.

---

Add a 👍 reaction to pull requests you find important.

[MattSturgeon]

There are probably a few individual cases of documentation that could refer to "nixfmt" the project instead of nixfmt thhe package.

But those should be considered individually, and as a whole this should definitely be reverted for now.

[wolfgangwalther]

I'm not sure whether this should be reverted in full. There are some cases of docs here (where the alias was not changed), but there are also cases of update scripts - and IIRC, these have been changed already.

Edit: Congratz on that nice green checkmark, @MattSturgeon! Welcome!

[jfly]

There are probably a few individual cases of documentation that could refer to "nixfmt" the project instead of nixfmt hhe package.

I skimmed the diff and didn't see any situations in docs where we're clearing disambiguating between the project and the executable name. So I left these entirely reverted. But please feel free to leave comments on individual lines where you think they should change.

but there are also cases of update scripts - and IIRC, these have been changed already.

I've added a commit that drops usage of nixfmt-rfc-style alias in update scripts.

[MattSturgeon]

Edit: Congratz on that nice green checkmark, @MattSturgeon! Welcome!

Thanks!

there are also cases of update scripts - and IIRC, these have been changed already.

I'd argue using the alias is also relevant in nix-shell -p shebangs, as we don't know which revision of nixpkgs is on the NIX_PATH. It could easily be a stable release or an old revision of unstable; either way we need the rfc-style alias for the update script to work as expected.

(Ideally such update scripts would be using treefmt from the nixpkgs shell, but that's a wider issue than a simple revert)

[wolfgangwalther]

(Ideally such update scripts would be using treefmt from the nixpkgs shell, but that's a wider issue than a simple revert)

Ah.. that was the change we made about update scripts. So in fact, we should not keep nixfmt in these shebangs, but also not nixfmt-rfc-style. We should remove either, similar to b68cc63.

[MattSturgeon]

Oh yes, I remember now.

I'm still unsure if expecting users to already be in the nixpkgs shell before running update scripts is reasonable, but it is better than using the wrong formatter.

I wonder if these update scripts added back nixfmt and/or nixfmt-rfc-style to the shebang, because their respective package maintainers weren't aware they were supposed to run their update scripts from within the nixpkgs shell?

[wolfgangwalther]

I wonder if these update scripts added back nixfmt and/or nixfmt-rfc-style to the shebang, because their respective package maintainers weren't aware they were supposed to run their update scripts from within the nixpkgs shell?

I looked into that:

• One of them did in gren: 0.4.5 -> 0.6.1 #401729.
• Another update script was added since then: linux_xanmod, linux_xanmod_latest: add update script #401636.
• The xorg one is special, because it runs nix-shell --pure. So relying on the environment won't work there. Maybe that's why it was left out of the original commit.

[wolfgangwalther]

Ah.. that was the change we made about update scripts. So in fact, we should not keep nixfmt in these shebangs, but also not nixfmt-rfc-style. We should remove either, similar to b68cc63.

Done in #433588.