sile: v0.9.5.1 -> v0.10.3; adjust build process #77738

alerque · 2020-01-15T08:44:25Z

Motivation for this change

New release of SILE upstream (announcement) has new dependencies and a different build system. Overall it should be easier to packages, but for this release cycle there are several changes.

Note I am not a Nix user, I am an upstream maintainer trying to facilitate this update. There are several things NOT done yet that I don't know how to fix:

The ./configure command needs to be passed the --with-system-luarocks argument if, as in the current package, all the external Lua Rocks are being supplied by the package manager. Alternatively if it would be better for Nix not to bother with those and just have SILE bundle the deps itself, you can just drop all the Lua package deps and not pass this argument and it will bundle everything.
The man page should get packaged too, is it?

If there is anything else I can facilitate so this packages easily let me know.

Things done

teto · 2020-01-15T14:13:53Z

Thanks a lot for the effort. I believe it would be best to have a nixos user take over now that you have highlighted the main changes. Some users are using it so we should be able to add maintainers for the package, I remember #56873 for instance. @ck3d would you mind ?

teto · 2020-01-15T14:14:32Z

pkgs/tools/typesetting/sile/default.nix

  '';

  postInstall = ''
-    install -D -t $out/share/doc/sile documentation/*.pdf
+    install -D -t $out/share/doc/sile documentation/sile.pdf


shouldn't upstream install the doc ? or provide a target install-doc ?

Can you point me do documentation or a good case study for how make install-doc should work? I'd be happy to get it setup properly upstream but I'm unsure what the outcome should look like.

The manual (documentation/sile.pdf) actually comes precompiled in the source tarballs now so you can skip the make documentation unless you are building from git HEAD. Note this is also why Gentium-Book and DeJavu fonts are not requirements. If building the manual you'd need those back.

teto · 2020-01-15T14:15:02Z

pkgs/tools/typesetting/sile/default.nix

@@ -46,11 +44,12 @@ stdenv.mkDerivation rec {
  enableParallelBuilding = true;

  checkPhase = ''
-    make documentation/developers.pdf documentation/sile.pdf
+    make documentation examples


weird to build documentation in a checkPhase. Eventually documentation generation could be toggled via a withDoc flag.

Should I be adding --with-documentation as a ./configure flag so that make all includes these (or not) without needing to know to trigger the extra targets?

Documentation can be dropped from here, make examples is actually not a bad way to do a simple check that everything is working. The downside is going to be that it downloads a bunch of fonts to do that. make busted would be a better check, but requires extra dependencies. Just checking ./sile --version might be an acceptable check phase.

teto · 2020-01-15T14:15:59Z

pkgs/tools/typesetting/sile/default.nix

 }:

 with stdenv.lib;

 let
-  luaEnv = lua.withPackages(ps: with ps;[ lpeg luaexpat lua-zlib luafilesystem luasocket luasec]);
+  luaEnv = lua.withPackages(ps: with ps;[cassowary linenoise lpeg lua-zlib lua_cliargs luaepnf luaexpat luafilesystem luarepl luasec luasocket stdlib vstruct]);


I believe some of these packages cassowary/linenoise should be added to nixpkgs since they don't appear in pkgs/development/lua-modules/generated-packages.nix

ck3d · 2020-01-19T11:31:17Z

I tried to get the package working, but I struggled with the new lua package dependencies.

Could someone who has experience with lua packages decide which way to go:

package missing lua packages in nixpkgs or
use lua packages provided with sile?

teto · 2020-01-19T13:21:15Z

We should strive for 1: I can help with packaging the missing lua packages see the (slightly outdated) doc https://github.com/NixOS/nixpkgs/pull/55302/files .
Basically add the name to maintainers/scripts/luarocks-packages.csv and run the associated script to regenenerate pkgs/development/lua-modules/generated-packages.nix (the script should be mentioned at top of that file).

alerque · 2020-01-24T14:51:51Z

v0.10.1 is out upstream. There are no changes that should affect packaging.

teto · 2020-01-24T19:46:50Z

I've packaged the missing lua packages to help with this.

teto · 2020-01-25T20:09:40Z

@GrahamcOfBorg eval

marsam · 2020-02-11T09:17:04Z

I managed to build it with 3264166, acf4f8b, and 2ca5d8d

On darwin needs tweaks for #65351

alerque · 2020-02-11T10:08:13Z

@marsam Thanks for your work on this. Please instruct me if I'm doing something wrong handling this PR. I just rebased on master and cherry picked your commits.

Something doesn't seem right about the addition of compat53 in the Lua module list. That module is a collection of shims to add Lua 5.3 features to 5.2 and 5.1. Both the configure process and the runtime should know it is not needed in this case.

marsam · 2020-02-11T13:06:15Z

Something doesn't seem right about the addition of compat53 in the Lua module list

it's required by configure for lua<5.3, and currently nixpkgs uses lua 5.2, if you don't want compat53 I think you can either patch configure.ac or use lua5_3

https://github.com/sile-typesetter/sile/blob/fba931a416b6f9118a096a170f78929e31a99595/configure.ac#L109-L111

alerque · 2020-02-11T13:20:35Z

@marsam My apologies, I thought Nix was at Lua 5.3. I have removed that commit as it was completely bogus.

alerque · 2020-02-12T12:57:51Z

I see CI has passed. Dose that mean anything?

From the upstream side the only remaining question I have about this is whether the man page ended up where it was supposed to. Otherwise I think it's up to you Nix folks to review and help check off the regular PR checklist ;-)

Thanks for the help everybody.

marsam · 2020-02-12T13:30:54Z

Thank you @alerque, I'm going to address the man page installation in another PR

alerque · 2020-02-12T14:17:24Z

@marsam It seems like make install is putting it in a standard location, so it might already be captured. Thanks again for all the help!

alerque mentioned this pull request Jan 15, 2020

v0.10.0 release checklist sile-typesetter/sile#778

Closed

21 tasks

alerque force-pushed the sile-v0.10.0 branch from 7aa9526 to 3f7d02c Compare January 15, 2020 08:56

teto reviewed Jan 15, 2020

View reviewed changes

alerque mentioned this pull request Jan 24, 2020

v0.10.1 release checklist sile-typesetter/sile#794

Closed

21 tasks

teto mentioned this pull request Jan 24, 2020

Lua for sile #78432

Merged

10 tasks

This was referenced Feb 3, 2020

v0.10.2 release checklist sile-typesetter/sile#817

Closed

v0.10.3 release checklist sile-typesetter/sile#820

Closed

alerque changed the title ~~sile: v0.9.5.1 -> v0.10.0; adjust build process~~ sile: v0.9.5.1 -> v0.10.3; adjust build process Feb 11, 2020

alerque force-pushed the sile-v0.10.0 branch from 3deed57 to 4993695 Compare February 11, 2020 10:01

ofborg bot added the 6.topic: lua label Feb 11, 2020

ofborg bot added the 8.has: package (new) label Feb 11, 2020

ofborg bot requested a review from marsam February 11, 2020 10:14

ofborg bot added 10.rebuild-darwin: 11-100 10.rebuild-linux: 11-100 labels Feb 11, 2020

marsam and others added 5 commits February 11, 2020 16:18

luaPackages.cassowary: init at 2.2-1

0b2a15f

luaPackages.cosmo: init at 16.06.04-1

7d64380

sile: v0.9.5.1 -> v0.10.0, adjust build process

cceb24e

sile: v0.10.0 → v0.10.1

df44e2e

sile: note manual comes precompiled in tarball

870e509

alerque and others added 2 commits February 11, 2020 16:18

sile: Bump to 0.10.3 and add missing lua dependency

928e648

sile: fix build

984256e

alerque force-pushed the sile-v0.10.0 branch from 878d08b to 984256e Compare February 11, 2020 13:18

alerque requested a review from ck3d February 12, 2020 12:56

marsam merged commit 802ad5f into NixOS:master Feb 12, 2020

alerque deleted the sile-v0.10.0 branch February 12, 2020 14:17

Janik-Haag added the 12. first-time contribution label Jun 12, 2023

doronbehar mentioned this pull request Oct 8, 2023

feat(tooling): Add nix packages building sile with clang sile-typesetter/sile#1883

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sile: v0.9.5.1 -> v0.10.3; adjust build process #77738

sile: v0.9.5.1 -> v0.10.3; adjust build process #77738

alerque commented Jan 15, 2020 •

edited

teto commented Jan 15, 2020

teto Jan 15, 2020

alerque Jan 24, 2020

alerque Jan 24, 2020

teto Jan 15, 2020

alerque Jan 24, 2020

alerque Jan 24, 2020

teto Jan 15, 2020

ck3d commented Jan 19, 2020

teto commented Jan 19, 2020

alerque commented Jan 24, 2020

teto commented Jan 24, 2020

teto commented Jan 25, 2020

marsam commented Feb 11, 2020

alerque commented Feb 11, 2020

marsam commented Feb 11, 2020

alerque commented Feb 11, 2020

alerque commented Feb 12, 2020

marsam commented Feb 12, 2020

alerque commented Feb 12, 2020

sile: v0.9.5.1 -> v0.10.3; adjust build process #77738

sile: v0.9.5.1 -> v0.10.3; adjust build process #77738

Conversation

alerque commented Jan 15, 2020 • edited

Motivation for this change

Things done

teto commented Jan 15, 2020

teto Jan 15, 2020

Choose a reason for hiding this comment

alerque Jan 24, 2020

Choose a reason for hiding this comment

alerque Jan 24, 2020

Choose a reason for hiding this comment

teto Jan 15, 2020

Choose a reason for hiding this comment

alerque Jan 24, 2020

Choose a reason for hiding this comment

alerque Jan 24, 2020

Choose a reason for hiding this comment

teto Jan 15, 2020

Choose a reason for hiding this comment

ck3d commented Jan 19, 2020

teto commented Jan 19, 2020

alerque commented Jan 24, 2020

teto commented Jan 24, 2020

teto commented Jan 25, 2020

marsam commented Feb 11, 2020

alerque commented Feb 11, 2020

marsam commented Feb 11, 2020

alerque commented Feb 11, 2020

alerque commented Feb 12, 2020

marsam commented Feb 12, 2020

alerque commented Feb 12, 2020

alerque commented Jan 15, 2020 •

edited