awesome: Make sure it compiles with luajit #71292

doronbehar · 2019-10-17T16:12:54Z

Motivation for this change

Say a user wishes to have a derivation of awesome that will use luajitPackages instead of the default lua52Packages, he will probably use the following overlay:

self: super:

{
  awesome = super.awesome.override {
    luaPackages = super.luajitPackages;
  };
}

But, that will lead him to the following build error:

-- Could NOT find Lua (missing: LUA_LIBRARIES) (found version "5.1.4")
CMake Error at awesomeConfig.cmake:70 (message):
  Could not find Lua.  See the error above.

  You might want to hint it using the LUA_DIR environment variable, or set
  the LUA_INCLUDE_DIR / LUA_LIBRARY CMake variables.
Call Stack (most recent call first):
  CMakeLists.txt:33 (include)


-- Configuring incomplete, errors occurred!
See also "/build/source/build/CMakeFiles/CMakeOutput.log".
builder for '/nix/store/9lm5fh1ij4rxh2qmi1c5q9a3v8hmk145-awesome-4.3.drv' failed with exit code 1
error: build of '/nix/store/9lm5fh1ij4rxh2qmi1c5q9a3v8hmk145-awesome-4.3.drv' failed

Applying this patch fixes this error and it will allow to easily build a working derivation of Awesome that uses LuaJIT.

Things done

Notify maintainers

cc @lovek323
cc @rasendubi
cc @ndowens

teto · 2019-10-17T18:25:10Z

I feel like the best way to do this would be to pass as buildInput a luaEnv equal to lua.withPackages(p: with p; [ lgi ... ]) (and remove the with luaPackages)

doronbehar · 2019-10-18T07:07:44Z

Furthermore, it would be even better to have a awesome-unwrapped and wrapper packages, just like with Neovim and support for extraLuaPackages just like Neovim's extraPythonPackages. Would you like me to work on that @teto?

teto · 2019-10-18T07:39:23Z

Do you know about the module ? lua modules in nixos/modules/services/x11/window-managers/awesome.nix via luaModules. The wrapper approach may be more straightforward for certain aspects than the module one so it could still be an interesting thing to do.

I have no strong opinon there, I dont use awesome.

doronbehar · 2019-10-18T07:42:42Z

Personally, I like installing most of my general use software to my user environment and not configuring it via the module systems.

rasendubi

Looks good to me.

doronbehar · 2019-10-19T10:01:41Z

@rasendubi what do you think about the suggestion to have a wrapped and unwrapped version of awesome and that the wrapped version will enable specifying lua packages to include in the search path? Just like with Neovim, wrapped and unwrapped:

nixpkgs/pkgs/applications/editors/neovim/default.nix

Lines 1 to 26 in 7885eea

    
           { stdenv, fetchFromGitHub, cmake, gettext, msgpack, libtermkey, libiconv 
        
           , libuv, lua, ncurses, pkgconfig 
        
           , unibilium, xsel, gperf 
        
           , libvterm-neovim 
        
           , withJemalloc ? true, jemalloc 
        
           , glibcLocales ? null, procps ? null 
        
           # now defaults to false because some tests can be flaky (clipboard etc) 
        
           , doCheck ? false 
        
           }: 
        
           with stdenv.lib; 
        
           let 
        
             neovimLuaEnv = lua.withPackages(ps: 
        
               (with ps; [ lpeg luabitop mpack ] 
        
               ++ optionals doCheck [ 
        
                   nvim-client luv coxpcall busted luafilesystem penlight inspect 
        
                 ] 
        
               )); 
        
           in 
        
             stdenv.mkDerivation rec { 
        
               pname = "neovim-unwrapped"; 
        
               version = "0.4.2"; 
        
               src = fetchFromGitHub {

nixpkgs/pkgs/applications/editors/neovim/wrapper.nix

Lines 1 to 59 in 7885eea

    
           { stdenv, lib, makeWrapper 
        
           , vimUtils 
        
           , bundlerEnv, ruby 
        
           , nodejs 
        
           , nodePackages 
        
           , pythonPackages 
        
           , python3Packages 
        
           }: 
        
           with stdenv.lib; 
        
           neovim: 
        
           let 
        
             wrapper = { 
        
                 extraMakeWrapperArgs ? "" 
        
               , withPython ? true,  extraPythonPackages ? (_: []) /* the function you would have passed to python.withPackages */ 
        
               , withPython3 ? true,  extraPython3Packages ? (_: []) /* the function you would have passed to python.withPackages */ 
        
               , withNodeJs? false 
        
               , withRuby ? true 
        
               , vimAlias ? false 
        
               , viAlias ? false 
        
               , configure ? {} 
        
             }: 
        
             let 
        
             rubyEnv = bundlerEnv { 
        
               name = "neovim-ruby-env"; 
        
               gemdir = ./ruby_provider; 
        
               postBuild = '' 
        
                 ln -sf ${ruby}/bin/* $out/bin 
        
               ''; 
        
             }; 
        
             /* for compatibility with passing extraPythonPackages as a list; added 2018-07-11 */ 
        
             compatFun = funOrList: (if builtins.isList funOrList then 
        
               (_: lib.warn "passing a list as extraPythonPackages to the neovim wrapper is deprecated, pass a function as to python.withPackages instead" funOrList) 
        
               else funOrList); 
        
             extraPythonPackagesFun = compatFun extraPythonPackages; 
        
             extraPython3PackagesFun = compatFun extraPython3Packages; 
        
             requiredPlugins = vimUtils.requiredPlugins configure; 
        
             getDeps = attrname: map (plugin: plugin.${attrname} or (_:[])); 
        
             pluginPythonPackages = getDeps "pythonDependencies" requiredPlugins; 
        
             pythonEnv = pythonPackages.python.withPackages(ps: 
        
                   [ ps.pynvim ] 
        
                   ++ (extraPythonPackagesFun ps) 
        
                   ++ (concatMap (f: f ps) pluginPythonPackages)); 
        
             pluginPython3Packages = getDeps "python3Dependencies" requiredPlugins; 
        
             python3Env = python3Packages.python.withPackages (ps: 
        
                   [ ps.pynvim ] 
        
                   ++ (extraPython3PackagesFun ps) 
        
                   ++ (concatMap (f: f ps) pluginPython3Packages)); 
        
             binPath = makeBinPath (optionals withRuby [rubyEnv] ++ optionals withNodeJs [nodejs]); 
        
             in 
        
             stdenv.mkDerivation {

rasendubi · 2019-10-19T10:57:42Z

As long as we keep the awesome module API stable, I'm fine with the wrapper approach. As a bonus, it could remove a minor duplication between nixpkgs awesome module and home-manager's one.

doronbehar · 2019-10-19T14:30:16Z

This will certainly enable removing the duplication but it will require changes to the Nixpkgs' module and home-manager's module similarly. Taking this into consideration, I think it'll be wiser to tackle this proposal in a separate PR. I don't use home-manager but I think my change won't break the way home-manager adds Lua modules to the search path.

doronbehar · 2019-10-19T14:36:35Z

@ndowens and @lovek323 are still invited for review...

nixos-discourse · 2019-10-21T10:28:29Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/61

nixos-discourse · 2020-08-11T19:58:05Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/awesomewm-luamodules-apparently-not-taking-effect/8507/5

awesome: Make sure it compiles with luajit

ab9fd67

ofborg bot requested review from ndowens, rasendubi and lovek323 October 17, 2019 16:27

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Oct 17, 2019

rasendubi approved these changes Oct 18, 2019

View reviewed changes

rasendubi merged commit 2695914 into NixOS:master Oct 21, 2019

doronbehar deleted the awesome-luajit branch March 2, 2023 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

awesome: Make sure it compiles with luajit #71292

awesome: Make sure it compiles with luajit #71292

doronbehar commented Oct 17, 2019

teto commented Oct 17, 2019

doronbehar commented Oct 18, 2019

teto commented Oct 18, 2019 •

edited

doronbehar commented Oct 18, 2019

rasendubi left a comment

doronbehar commented Oct 19, 2019

rasendubi commented Oct 19, 2019

doronbehar commented Oct 19, 2019

doronbehar commented Oct 19, 2019

nixos-discourse commented Oct 21, 2019

nixos-discourse commented Aug 11, 2020

awesome: Make sure it compiles with luajit #71292

awesome: Make sure it compiles with luajit #71292

Conversation

doronbehar commented Oct 17, 2019

Motivation for this change

Things done

Notify maintainers

teto commented Oct 17, 2019

doronbehar commented Oct 18, 2019

teto commented Oct 18, 2019 • edited

doronbehar commented Oct 18, 2019

rasendubi left a comment

Choose a reason for hiding this comment

doronbehar commented Oct 19, 2019

rasendubi commented Oct 19, 2019

doronbehar commented Oct 19, 2019

doronbehar commented Oct 19, 2019

nixos-discourse commented Oct 21, 2019

nixos-discourse commented Aug 11, 2020

teto commented Oct 18, 2019 •

edited