search

NixOS / cabal2nix

Generate Nix build instructions from a Cabal file
https://haskell4nix.readthedocs.io
Other
352 stars 154 forks source link

Generate `meta.longDescription` #608

Open srid opened 10 months ago

srid commented 10 months ago

When the cabal file has synopsis and description properties, cabal2nix should translate them to Nix's meta.description and meta.longDescription correspondingly.

sternenseemann commented 10 months ago

synopsis is mapped to description. Also mapping description to longDescription may not be a good idea for nixpkgs, as it would probably dramatically inflate the size of the already huge hackage-packages.nix. We could add it as an optional feature, but I don't think it is very useful outside of nixpkgs.

srid commented 10 months ago

We could add it as an optional feature, but I don't think it is very useful outside of nixpkgs.

Well, a bunch of tools do use longDescription. For eg. https://search.nixos.org/packages does. And 3rd party tools may as well. So +1 on having it as optional (leaving it disabled for pkgs.haskellPackages.*).