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.

Sign up for GitHub

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
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions pkgs/applications/editors/emacs/build-support/melpa.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,10 @@ libBuildHelper.extendMkDerivation' genericBuild (finalAttrs:
/*
recipe: Optional MELPA recipe.
Default: a minimally functional recipe
This can be a path of a recipe file, a string of the recipe content or an empty string.
The default value is used if it is an empty string.
*/
, recipe ? (writeText "${finalAttrs.pname}-recipe" ''
(${finalAttrs.ename} :fetcher git :url ""
${lib.optionalString (finalAttrs.files != null) ":files ${finalAttrs.files}"})
'')
, recipe ? ""
, preUnpack ? ""
, postUnpack ? ""
, meta ? {}
Expand Down Expand Up @@ -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 •
edited
Loading

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 •
edited
Loading

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.

if [ -r "$recipe" ]; then
ln -s "$recipe" "$recipeFile"
nixInfoLog "link recipe"
elif [ -n "$recipe" ]; then
printf "%s" "$recipe" > "$recipeFile"
nixInfoLog "write recipe"
else
cat > "$recipeFile" <<'EOF'
(${finalAttrs.ename} :fetcher git :url "" ${lib.optionalString (finalAttrs.files != null) ":files ${finalAttrs.files}"})
EOF
nixInfoLog "use default recipe"
fi
nixInfoLog "recipe content:" "$(< $recipeFile)"
unset -v recipeFile

ln -s "$packageBuild" "$NIX_BUILD_TOP/package-build"

Expand Down