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

emacsPackages: clean the things up #351056

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Conversation

AndersonTorres
Copy link
Member

@AndersonTorres AndersonTorres commented Oct 25, 2024

Basically, rework the bulk updating framework.

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

Copy link
Contributor

@jian-lin jian-lin left a comment

Choose a reason for hiding this comment

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

Adding documentation is always good.

Please remove those commits updating elisp packages.

pkgs/applications/editors/emacs/elisp-packages/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be good to put this doc into Nixpkgs manual. https://nixos.org/manual/nixpkgs/unstable/#chap-language-support is a good place.

Copy link
Contributor

Choose a reason for hiding this comment

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

What is motivation of factoring out this lib-update-scripts.sh? It has only one consumer and factoring out it adds complexity like SOURCE and DIR.

Copy link
Member Author

Choose a reason for hiding this comment

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

I am cogitating to split the functions here so that they could be loaded via source lib-update-scripts.sh and so be executed interactively.

E.g. the function that tests the package set can be run whether the set was generated locally or downloaded from the overlay.

Copy link
Contributor

@jian-lin jian-lin Oct 25, 2024

Choose a reason for hiding this comment

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

Sounds good. What about adding that to the doc?

Copy link
Member Author

Choose a reason for hiding this comment

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

I have documented it.

Comment on lines 12 to 13
The easiest one is to download and commit the package sets from [`nix-community`
Emacs Overlay](https://github.com/nix-community/emacs-overlay). The script
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend using Semantic Line Breaks which is used at many places, such as Nix RFCs.

@jian-lin

This comment was marked as resolved.

By putting them on a separate file `lib-update-scripts.sh`, the file can be
`source`'d and so the functions can be used in both batch and interactive
environments.
They are practically identical. Let's merge them in a single script.

Now they can be called via `./update-package-sets <package sets>`.
They will be gathered in a more fitting documentation.
For now it has documentation for bulk updaters.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants