texlive.withPackages: add withDocs, withSources and expose texliveFullWithDocs at top level

[xworld21]

Expose new attributes withDocs, withSources that evaluate to the same texlive.withPackages derivation, but with withDocs = true. I have added texliveFullWithDocs at the top level to have Hydra add all texdoc containers to the binary cache.

If this gets merged, I think we can finally deprecate texlive.combine for good, and start updating the documentation.

There's a bit of history around these changes.

I tried to implement .overrideAttrs { withDocs = true; } quite some time ago (#312945), but it died out, it's just too cumbersome to implement (see also #432957) and it doesn't look like people were clamoring for it. .overrideAttrs is also tricky to get right, because some overrides require rebuilding the formats, some don't. It's hard to come up with an overriding mechanism that captures this nicely. Instead, .withDocs is embarrassingly simple to add (and suggests adding .withPaper for switching defaults between A4 and letter). At any rate, if we manage to implement a version .overrideAttrs { withDocs = true; }, leaving the .withDocs alias is very cheap.

The top level texliveFullWithDocs is odd, but when I tried to have Hydra build all texdoc containers via texlivePackages, I was told that in fact building each TeX Live package separately causes scheduling issues. I forgot where that conversation was!

Things done

• Built on platform:
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• Tested, as applicable:
  • NixOS tests in nixos/tests.
  • Package tests at passthru.tests.
  • Tests in lib/tests or pkgs/test for functions and "core" functionality.
• Ran nixpkgs-review on this PR. See nixpkgs-review usage.
• Tested basic functionality of all binary files, usually in ./result/bin/.
• Nixpkgs Release Notes
  • Package update: when the change is major or breaking.
• NixOS Release Notes
  • Module addition: when adding a new NixOS module.
  • Module update: when the change is significant.
• Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other READMEs.

[chrjabs]

Even though I've done the last couple of texlive version updates, I'm not actually too familiar with the internals of how the packaging works. Is there some discussion somewhere on deprecating texlive.combine?

[chrjabs]

Tests (nix-build ../../../../.. -A tests.texlive --no-out-link) and build of texliveFullWithDocs (nix build .#texliveFullWithDocs) pass (on x86_64-linux), so looks good to me.

[xworld21]

Is there some discussion somewhere on deprecating texlive.combine?

I have mentioned it a few times since introducing texlive.withPackages, because there's a lot of extra code to maintain compatibility with texlive.combine and it's all very ugly. I'll open a discussion, though. I am not sure myself how to deprecate it properly (starting with 26.05 or right after 26.05? etc etc).

[nixos-discourse]

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

https://discourse.nixos.org/t/how-and-when-to-deprecate-texlive-combine-looking-for-tex-live-reviewers/76121/1

[veprbl]

LGTM

[xworld21]

Great, if somebody can merge, in the meanwhile I'll start making documentation updates.

[xworld21]

The new buildEnv has just been merged into staging, which means .overrideAttrs { withDocs = true; } is now feasible, and clearly the correct way to go. It just requires a bit of restructuring inside build-tex-env.nix. The only practical problem is that staging and master are quite out of sync, so I'll need to wait before I can make a safe PR.

[xworld21]

Superseded by #506700.