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

emacs: make melpaBuild accept recipe content as a string #334955

Merged
merged 1 commit into from
Aug 28, 2024

Conversation

jian-lin
Copy link
Contributor

@jian-lin jian-lin commented Aug 15, 2024

This is the first part of #334888. (I probably won't do the second part, i.e., changing the code for generating MELPA index).

Presumably, this PR does not change the built packages. I have rebeased the commit onto master and verified that the content of urweb-mode (default recipe) and flycheck (file path as recipe) does not change. However, duo to the limitation of nix, this triggers rebuilds of all packages built with melpaBuild.

I have also tested three possible branches.

Description of changes

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.

@@ -98,9 +97,21 @@ libBuildHelper.extendMkDerivation' genericBuild (finalAttrs:

preUnpack = ''
mkdir -p "$NIX_BUILD_TOP/recipes"
if [ -n "$recipe" ]; then
cp "$recipe" "$NIX_BUILD_TOP/recipes/$ename"
recipeFile="$NIX_BUILD_TOP/recipes/$ename"
Copy link
Member

Choose a reason for hiding this comment

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

I usually treat Bash as a lower level language.
I avoid it when the same thing can be done with Nix/Nixpkgs machinery.

If I understood this correctly, this code tries to detect if the recipe is a file or a string.
If file, pick it as is.
If string, put the string contents into a file.

This is similar to postPatch hook from dwl:

https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/dw/dwl/package.nix#L78-L86

Copy link
Contributor Author

@jian-lin jian-lin Aug 16, 2024

Choose a reason for hiding this comment

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

Hmm, the point is to support not using a derivation for recipe, as @adisbladis said in #330589 (comment).

So writing some bash is inevitable, I guess.

Copy link
Member

Choose a reason for hiding this comment

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

Hum, I do not know if this is the idea from adisbladis in that comment.

To me it looked like "the user (whether human or machine) should have the option to pass a file or a string" (and, of course, files can be generated by derivations too).

In this sense the example I provided looks cleaner and reduces the Bash code to a couple lines.
The Nix code receives the recipe in whatever format, and returns a file containing the recipe, so that the Bash code does nothing besides linking that file.

The only advantage of using the Bash code I can think is maybe some micro optimization.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the goal to avoid using a derivation for recipe. So in your example, this should be avoided.

Copy link
Member

@AndersonTorres AndersonTorres Aug 16, 2024

Choose a reason for hiding this comment

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

It does make any difference? In the end we have a string converted to a file, whether if it is made by Bash or Nix+Nixpkgs.
(Further, if I remember correctly, a raw file is converted to a derivation too.)

I think the Nix code is slightly more readable.
On the other hand, if the Bash code is more efficient (maybe because Nix is slower, or some context in the background has a hidden penalty), then it would be something positive.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess not using a derivation increases performances a bit. To benchmark that, someone needs to make generated melpa packages use recipe content string first.

@wegank wegank added the 12.approvals: 1 This PR was reviewed and approved by one reputable person label Aug 20, 2024
@jian-lin jian-lin merged commit 63bec82 into NixOS:staging Aug 28, 2024
37 checks passed
@jian-lin jian-lin deleted the pr/melpaBuild-recipe-string branch August 28, 2024 08:36
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.

3 participants