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.

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

[WiP] gtk-doc: patch the on-line DocBook XSL paths to the local #56504

Open
wants to merge 1 commit into
base: master
from

Conversation

@amiloradovsky
Copy link
Contributor

amiloradovsky commented Feb 28, 2019

This is what's done in Guix, so gtkdoc-mkhtml would in no case even try to reach for the Internet.
Also removed dblatex, because it was never enabled and causes circular dependencies if it is.
The --disable-scrollkeeper configure flag isn't recognized by now.
And doCheck should be left alone, as long as the tests pass.

Motivation for this change

Cleaning up, robustness.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

The [WiP] tag is because I couldn't test the impact on the other packages due to the limits of my hardware and Internet connection, and also because much of those packages fail for the deprecation warnings, not sure what that means.

This is what's done in Guix,
so `gtkdoc-mkhtml` would in no case even try to reach for the Internet.
Also removed `dblatex`,
because it was never enabled and causes circular dependencies if it is.
The `--disable-scrollkeeper` configure flag isn't recognized by now.
And `doCheck` should be left alone, as long as the tests pass.
@jtojnar

This comment has been minimized.

Copy link
Contributor

jtojnar commented May 1, 2019

The URI is, in the first place, an identifier of the stylesheet; the method the stylesheet will be obtained is independent of this. The primary source for locating the resources is the XML catalog; the fact that the URI can be used as a web URL is secondary and should not bother us – we, as packagers, are responsible for making the proper catalogs available.

I like the idea of limiting the scope where docbook-xsl is available to gtk-doc. In nixpkgs, sometimes the runtime dependencies of build tools are made available through dependencies of the depending package. This is usually done when the dependency is only used for a specific subsystem of the build tool (e.g. PDF generation) and we do not want to increase the closure of the tool for people who only need HTML export. However, since DocBook support will almost always be used, adding the stylesheet as a direct dependency to gtk-doc makes sense.

I am not very fond of patching over the URI with store path directly, though. I would rather rely on the catalogs still (perhaps using wrapProgram). The path you used is no longer the correct one.

@Infinisil

This comment has been minimized.

Copy link
Member

Infinisil commented Jan 23, 2020

Status on this? If there's no interest anymore we should close this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.