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

Clean up data writers #263096

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Clean up data writers #263096

merged 3 commits into from
Oct 24, 2023

Conversation

roberth
Copy link
Member

@roberth roberth commented Oct 24, 2023

Description of changes

These functions appear to have been added by mistake.

This change is the bare minimum to reduce maintenance.

Whether to further deprecate or document the aliases is still to be decided.

See #244835 (review) and subsequent comments.

  • Remove duplicate implementations
  • Deprecate makeDataWriter; not used in Nixpkgs and neither specific enough nor general enough
  • Improve test, assuming we keep the aliases.

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/)
  • 23.11 Release Notes (or backporting 23.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.

@roberth roberth mentioned this pull request Oct 24, 2023
12 tasks
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux labels Oct 24, 2023
Copy link
Member

@Mic92 Mic92 left a comment

Choose a reason for hiding this comment

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

First I was concerned this wouldn't pretty print formats, but it does. So looks good to me.

@Mic92
Copy link
Member

Mic92 commented Oct 24, 2023

writers.writeJSON still seems more ergonomic to use than (pkgs.format.json {}).generate.

@delroth delroth added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Oct 24, 2023
@delroth delroth added 12.approvals: 2 This PR was reviewed and approved by two reputable people and removed 12.approvals: 1 This PR was reviewed and approved by one reputable person labels Oct 24, 2023
@roberth roberth merged commit c1dc59d into NixOS:master Oct 24, 2023
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux 12.approvals: 2 This PR was reviewed and approved by two reputable people
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants